Skip to contents

Set option parameters for sb_insert_event()

Source: R/import_option.R
sb_insert_event_option.Rd

Set option parameters for sb_insert_event()

Usage

sb_insert_event_option(
  interactive_mode = TRUE,
  id_col = c("user_id", "about", "username", "email"),
  table_field = NULL,
  cache = TRUE
)

Arguments

interactive_mode

If TRUE, all messages are printed to the console. If FALSE, they are suppressed. The idea is that interactive_mode should be set to FALSE to ensure logs aren't clogged up with progress messages in automated environments.

id_col

Name of column that smartabaseR should use for user identifier. By default the Smartabase API requires a "user_id" column, but other possible values are "about", "username" or "email".

table_field

Smartabase tables are used when you want to store multiple rows of data in one event. If you are importing data into a form that contains table fields, you must manually supply the names of those fields as a character vector to the table_field argument within the relevant import option helper function. This is equivalent to ticking 'Treat all records for the same user, on the same day as a single record?' in the Smartabase web app.

cache

If TRUE, login token and user details are cached once per session. To invalidate the cache, restart your R session.

Value

A list of options with class = "sb_import_option"

See also

sb_update_event_option() sb_upsert_event_option() sb_upsert_profile_option()

Other import option helpers: sb_update_event_option(), sb_upsert_event_option(), sb_upsert_profile_option()

Examples

if (FALSE) { # \dontrun{
# Calling the function with no arguments returns all the defaults
sb_insert_event_option()

# Specifying specific arguments will alter those arguments alone while still
# returning the other defaults
sb_insert_event_option(
  id_col = "about",
  table_field = c("Example Table Field Name")
)
} # }