Set up tflplanner's home — setup_tflplanner • tflplanner

Creates the folder where tflplanner keeps its settings and the saved state of every study, and says where new study folders go. Run it once; run_app() runs it with the defaults when it finds no home. Running it again changes the settings given and keeps the rest.

Usage

setup_tflplanner(
  home = NULL,
  studies_root = NULL,
  language = NULL,
  standards = NULL,
  sample = FALSE,
  port = NULL,
  check_updates = NULL
)

Arguments

home: The home folder. NULL keeps the current one (see tflplanner_home()); a folder given here is remembered for later sessions – one in the temporary folder only for this session.
studies_root: Where new study folders are created. NULL keeps the current setting, or on a first setup uses <home>/studies. The home holds the study folders or sits beside them, never inside them (nor inside a study's folder): such a setting is refused.
language: The app's language, "en" (the default) or "ja"; NULL keeps the current setting.
standards: A company standards workbook (standards_template()) to install, "builtin" to go back to the built-in draft, or NULL to keep what is installed.
sample: TRUE adds the sample study (SAMPLE-01) to the studies folder and makes its ARD and reports (create_sample_study()); a sample already there is left as it is.
port: The port the app runs on when started from its shortcut or launch_app() (default 7470); NULL keeps the setting.
check_updates: Whether the app looks for a newer version when it starts (default FALSE; it only says so, it installs nothing); NULL keeps the setting. tflplanner is updated only when you ask: update_tflplanner(), or the "update and launch" shortcut (add_shortcut(update = TRUE)).

Value

The settings, invisibly.

Details

Called with no arguments in an interactive session, it walks you through the setup step by step, asking before it changes anything:

the home folder and where new study folders go;
the packages tflplanner's programs use (cards, cardx, dplyr, ...) that are not installed yet (tflplanner_packages());
a shortcut that starts tflplanner with a double click (add_shortcut()).

Everything else – the study folders, the language, the company standards, the sample study – can be changed in the app's settings. To update tflplanner later, use update_tflplanner() or the "update and launch" shortcut.

Examples

# a home in the temporary folder: used in this R session only, nothing
# is written to your settings
old <- options(tflplanner.home = NULL)
setup_tflplanner(home = tempfile("tflplanner-home"))
#> The home /tmp/RtmpT9WaTi/tflplanner-home18ba1da3ba18 is in the temporary folder: it is used in this R session only, not remembered for later ones.
#> tflplanner home: /tmp/RtmpT9WaTi/tflplanner-home18ba1da3ba18
#> new studies go to: /tmp/RtmpT9WaTi/tflplanner-home18ba1da3ba18/studies
tflplanner_config()
#> $studies_root
#> [1] "/tmp/RtmpT9WaTi/tflplanner-home18ba1da3ba18/studies"
#> 
#> $last_study
#> NULL
#> 
#> $language
#> NULL
#> 
#> $update_channel
#> NULL
#> 
options(old)

if (FALSE) { # \dontrun{
# not run: these remember the home and the study folder for every later
# session (and the first one asks, step by step)
setup_tflplanner()
# the whole layout in one call: C:/tflplanner_home, its study folders in
# C:/tflplanner_home/studies, the sample study among them
setup_tflplanner(home = "C:/tflplanner_home", sample = TRUE)
# or the study folders beside the home
setup_tflplanner(home = "C:/tflplanner_home", studies_root = "C:/studies")
} # }