limer_upload_tsv_to_limesurvey.Rd
To use this function, you need to setup R for the LimeSuevey API, as
described in vignette("limesurvey_api_setup")
.
limer_upload_tsv_to_limesurvey(
ls_txt_path,
open_url = "preview",
hostname = getOption("lime_api")
)
Path of the limesurvey text file
Character vector containing one or more of the strings in
c("preview", "survey", "none")
. If it contains "none", nothing is done.
"preview"
(the default) previews the survey on limesurvey. "survey"
opens the survey summary.
The host to use (if not using the one specified in
the options). If no hostname is specified in the 'lime_api'
option and
no host name is passed as hostname
, the subdomain stored in
limonaid::opts$get("ls_subdomain")
will be combined with the
domain stored in limonaid::opts$get("ls_domain")
to create the
host name. You can change these using the limonaid::opts$set()
function.
The value of the id of your survey in the specified LimeSurvey installation,
if (FALSE) { # \dontrun{
### Log into the LimeSurvey API:
limonaid::get_session_key();
### Upload a tab separated values file:
limer_upload_tsv_to_limesurvey(
"PATH/TO/YOUR/LIMESURVEY/TXT FILE",
c("preview", "survey")
);
} # }