draft_results_text: Create some draft text to insert into the results section of...

In shirewoman2/Consultancy: Standardized tools for using R within the Simcyp Consultancy Team

Create some draft text to insert into the results section of a report describing the trial design of a simulation

Description

Create some draft text to insert into the results section of a report describing the trial design of a simulation

Usage

draft_results_text(
  sim_data_file,
  existing_exp_details,
  prettify_compound_names = TRUE,
  mean_type = "geometric"
)

Arguments

sim_data_file	name of the Excel file containing the simulator output, in quotes
existing_exp_details	the output from running either extractExpDetails or extractExpDetails_mult – either is fine as long as it contains details for sim_data_file.
prettify_compound_names	TRUE (default) or FALSE for whether to make compound names prettier in legend entries and in any Word output files. This was designed for simulations where the substrate and any metabolites, perpetrators, or perpetrator metabolites are among the standard options for the simulator, and leaving prettify_compound_names = TRUE will make the name of those compounds something more human readable. For example, "SV-Rifampicin-MD" will become "rifampicin", and "Sim-Midazolam" will become "midazolam".
mean_type	"arithmetic" or "geometric" (default) means in PK tables

Value

list of generic results text

Examples

# none yet

shirewoman2/Consultancy documentation built on Feb. 18, 2025, 10 p.m.