get_facts_file_example {rfacts}

Locate an example FACTS file

Description

Get the path to an example FACTS file inside rfacts itself.

Usage

get_facts_file_example(facts_file)

Arguments

facts_file

Character, name of a FACTS file. Usually has a ⁠*.facts⁠ file extension. Does not include the directory name. Possible choices:

• "aipf_contin.facts" - Enrichment continuous.

• "aipf_dichot.facts" - Enrichment dichotomous.

• "aipf_tte.facts" - Enrichment time to event.

• "broken.facts" - A broken FACTS file.

• "contin.facts" - Core continuous.

• "crm.facts" - N-CRM design.

• "dichot.facts" - Core dichotomous.

• "multep.facts" - Multiple endpoints.

• "staged.facts" - Staged design.

• "tte.facts" - Time to event.

• "unsupported.facts" - FACTS file with an unsupported engine type.

Details

The rfacts package comes with some example FACTS files. Use the get_facts_file_example() function to get the full path to an example FACTS file. Use this file to try out run_flfll(), run_engine_contin(), etc.

Value

Character, the path to a FACTS file included with rfacts.

See Also

run_facts(), run_flfll(), run_engine(), run_engine_contin()

Examples

# Only run if system dependencies are configured:
if (file.exists(Sys.getenv("RFACTS_PATHS"))) {
facts_file <- get_facts_file_example("contin.facts")
facts_file
out <- run_facts(
  facts_file,
  n_sims = 1,
  verbose = FALSE
)
read_patients(out)
}