formr_backup_study: Backup a study

View source: R/connect_to_formr.R

formr_backup_studyR Documentation

Backup a study

Description

Backup a study by downloading all surveys, results, item displays, run shuffle, user overview and user details. This function will save the data in a folder named after the study.

Usage

formr_backup_study(
  study_name,
  save_path = study_name,
  host = formr_last_host(),
  overwrite = FALSE
)

Arguments

study_name

case-sensitive name of a study your account owns

save_path

path to save the study data, defaults to the study name

host

defaults to formr_last_host(), which defaults to https://formr.org

overwrite

should existing files be overwritten?

Examples

## Not run: 
formr_backup_study(study_name = 'training_diary' )

## End(Not run)

rubenarslan/formr documentation built on Feb. 7, 2025, 6:31 a.m.