run_rmarkdown_rctls: Run Rmarkdown files

View source: R/run_rmarkdown.R

run_rmarkdown_rctlsR Documentation

Run Rmarkdown files

Description

This function runs several Rmarkdown files to generate standardised automated reports for the longitudinal study (LS) and the randomised controlled trial (RCT) for the Tools for Integrated Management of Childhood Illnesses (TIMCI) project.

Usage

run_rmarkdown_rctls(
  rctls_pid,
  rctls_pp,
  research_facilities,
  report_dir,
  participant_zip,
  mdb_dir,
  path_dir,
  start_date = NULL,
  end_date = NULL,
  lock_date = NULL,
  sample_size = 1e+05,
  short = FALSE
)

Arguments

rctls_pid

Numeric value that refers ID of the RCT/LS ODK Central project

rctls_pp

Passphrase

research_facilities

Dataframe that contains the research facilities

report_dir

Path to the output folder for the generated Rmarkdown reports

participant_zip

Path to the encrypted zip archive that stores participant data

mdb_dir

Path to the output folder for the RCT / LS database exports

path_dir

Path to the output folder for the M&E exports to be shared with PATH

start_date

RCT/LS data collection start date (optional)

end_date

RCT/LS data collection end date (optional)

lock_date

RCT/LS data collection cleaning end date for database lock (optional)

sample_size

Numeric value, sample size for RCT/LS enrolment

short

Short version of the export


Thaliehln/timci documentation built on April 8, 2024, 3:38 p.m.