susor_login: Define API credentials of your Survey Solutions server

In araupontones/susor:

Define API credentials of your Survey Solutions server

Description

susor_login() checks that your API cdedentials susor_server, susor_user, and susor_passowrd are correct and saves these credentials in the global environment so they can be used to communicate with the server This function must be run before any other function of this package susor.

Usage

susor_login(
  susor_server,
  susor_user,
  susor_password,
  susor_dir_downloads = "downloads",
  susor_dir_raw = "raw",
  limit = 40,
  ofset = 1,
  ...
)

Arguments

susor_server	A string. URL of your Survey Solution's server.
susor_user	A string. The API user defined in Survey Solutions Server.
susor_password	A string. Password of the API user.
susor_dir_downloads	A string. Path to the directory where the data exported from the server is going to be saved in your local drive. Default = 'downloads'.
susor_dir_raw	A string. Path to the directory where the raw data will be stored in your local drive.Default = 'raw.
limit	A number. Limit number of returned rows. Max allowed value is 40. Default=40
offset	Page number starting from 1. Default = 1

Value

All the parameters provided to the function (susor_server, susor_user, susor_password, susor_dir_downloads, and susor_dir_raw) will be saved in your global environment so can be used in your workflow. Additionally, A tibble named susor_questionnaires will be saved in your global environment. View this tibble to get: Questionnaire ID, etc.

Examples

susor_login(susor_server = "http://my.muvasurveys.com",
                  susor_user = "Diego_Maradona",
                  susor_password = "Pelusa123",
                  susor_dir_downloads = file.path("Dropbox", "downloads"),
                  susor_dir_raw = file.path("Dropbox", "raw")
)

araupontones/susor documentation built on May 12, 2022, 1:31 p.m.