Export Smartabase user data

sb_get_user() exports user data using the Smartabase API. It requires the user to input a valid Smartabase url and valid Smartabase credentials.

For more details see the help vignette: vignette("helper-functions")

Usage

sb_get_user(
  url,
  username,
  password,
  ...,
  filter = sb_get_user_filter(),
  option = sb_get_user_option()
)

Arguments

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 generated by a sb_get_user_filter() object

option

More options generated by a sb_get_user_option() object

Value

A tibble containing Smartabase user 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_user(), all optional filters must be generated by the sb_get_user_filter() function. Please see sb_get_user_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_user(), all options must be generated by the sb_get_user_option() function. Please see sb_get_user_option() for more details.

See also

sb_get_profile() for profile data. sb_get_user() for user data. sb_sync_event() to synchronise with an event form.

Other export functions: sb_get_event(), sb_get_profile(), sb_sync_event()

Examples

if (FALSE) { # \dontrun{
# Get user ID data about Jamie Anderson:
user_data <- sb_get_user(
  url = "example.smartabase.com/site",
  username = "example.username",
  password = "example_password",
  filter = sb_get_event_filter(
    user_key = "about",
    user_value = "Jamie Anderson"
  )
)

# Return all user columns:
user_data <- sb_get_user(
  url = "example.smartabase.com/site",
  username = "example.username",
  password = "example_password",
  option = sb_get_user_option(
    include_all_cols = TRUE
  )
)
} # }