Add the sample study — create_sample

Copies tflplanner's sample study into a studies folder and registers it: the simulated oncology study XYZ-ONC-01 of 'tflspec' (Drug X vs Control: its ADSL with the screen failures, ADAE, ADVS's systolic blood pressure and ADTTE), the ARD definition, five tables made from one study ARD, a listing and two figures – every step, from the ARD to the reports, defined in the app and written as Excel (spec/: the table and report definitions, the listing / figure definition and ard_spec.xlsx, an export of the ARD definition to read). With run = TRUE it then makes them – the ARD programs and the report programs, as an official run with its batch folder (see run_batch()) – so the study opens with its ARD and RTFs in place. setup_tflplanner()(sample = TRUE) does this at setup, and the app's New study dialog under a study ID of your own.

Usage

create_sample_study(
  root = studies_root(home),
  run = TRUE,
  study_id = .sample_id,
  title = NULL,
  compound = NULL,
  phase = NULL,
  description = NULL,
  short_title = NULL,
  home = tflplanner_home()
)

Arguments

root: The studies folder (default: where new studies go, see setup_tflplanner()).
run: Make the ARD and the reports (needs 'cards' and 'cardx').
study_id: The new study's ID (default SAMPLE-01).
title, short_title, compound, phase, description: The study's fields; NULL keeps the sample's.
home: tflplanner's home.

Value

The study, invisibly.

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-home18ba6bf1f87d is in the temporary folder: it is used in this R session only, not remembered for later ones.
#> tflplanner home: /tmp/RtmpT9WaTi/tflplanner-home18ba6bf1f87d
#> new studies go to: /tmp/RtmpT9WaTi/tflplanner-home18ba6bf1f87d/studies
# \donttest{
# (a few seconds: it writes the study's spec workbooks)
s <- create_sample_study(run = FALSE)  # run = TRUE makes its ARD and reports too
#> The sample study: /tmp/RtmpT9WaTi/tflplanner-home18ba6bf1f87d/studies/SAMPLE-01
list_studies()
#>    study_id                                         title short_title compound
#> 1 SAMPLE-01 Sample study (tflspec's oncology sample data)        <NA>   Drug X
#>   phase               saved
#> 1     2 2026-10-19 10:45:01
#>                                                            path folder
#> 1 /tmp/RtmpT9WaTi/tflplanner-home18ba6bf1f87d/studies/SAMPLE-01   TRUE
#>                                                                                                                                                         description
#> 1 The sample study of tflplanner: tflspec's simulated oncology study XYZ-ONC-01 (Drug X vs Control); one study ARD and tables, a listing and a figure made from it.
#>   reports analyses
#> 1      17       36
# }
options(old)