setup_ruODK: Connects R session to a form on ODK Central.

Description Usage Arguments Value

View source: R/setup_ruODK.R

Description

Establishes connection with ODK Central servers by passing log in credentials, timezone and svc to the ru_setup function. This is required in order to use most ruODK functions. By default, it tries to retrieve this information from local system variables.

Usage

1
2
3
4
5
6
7
setup_ruODK(
  svc,
  un = Sys.getenv("ODKC_UN"),
  pw = Sys.getenv("ODKC_PW"),
  tz = Sys.getenv("ODKC_TZ"),
  verbose = TRUE
)

Arguments

svc

Character that specifies the svc link which is used to identify an ODK form.

un

Character that specifies the ODK Central username. Optional, defaults to Sys.getenv('ODKC_UN').

pw

Character that specifies the ODK Central password. Optional, defaults to Sys.getenv('ODKC_PW').

tz

Character that specifies the ODK Central tiem zone Optional, defaults to Sys.getenv('ODKC_TZ').

verbose

Logical that sets the 'verbose' argument of the ru_setup function.

Value

None


lucidviews/repvisForODK documentation built on Feb. 13, 2022, 9:50 p.m.