Skip to contents

This function exports data from a Smartabase profile form using the Smartabase API. It requires the user to input a valid Smartabase event form name, url and credentials.

For more details see the help vignette: vignette("exporting-data")

Usage

sb_get_profile(
  form,
  url,
  username,
  password,
  ...,
  filter = sb_get_profile_filter(),
  option = sb_get_profile_option()
)

Arguments

form

Name of Smartabase profile form

url

Smartabase url e.g. "example.smartabase.com/site"

username

Smartabase username

password

Smartabase password

...

These dots are for future extensions and must be empty

filter

More filters accessible via sb_get_profile_filter()

option

More options accessible via sb_get_profile_option()

Value

tibble: Smartabase profile data

Filters

There are also a range extra filters than can be supplied to the filter argument. In order to reduce argument clutter in sb_get_profile(), all optional filters must be generated by the sb_get_profile_filter() function. Please see sb_get_profile_filter() for more details.

Options

There are also a range extra options than can be supplied to the option argument. In order to reduce argument clutter in sb_get_profile(), all options must be generated by the sb_get_profile_option() function. Please see sb_get_profile_option() for more details.

Examples

if (FALSE) { # \dontrun{
# Get profile data from "Athlete Profile" form:
sb_get_profile(
  form = "Athlete Profile",
  url = "example.smartabase.com/site",
  username = "example.user",
  password = "examplePassword"
)
} # }