draft_text_mult: Create some draft text to insert into the methods and results...

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

Create some draft text to insert into the methods and results sections of a report describing the trial design of several simulations at once

Description

Create some draft text to insert into the methods and results sections of a report describing the trial design of several simulations at once

Usage

draft_text_mult(
  sim_data_files = "use existing_exp_details",
  existing_exp_details,
  prettify_compound_names = TRUE,
  default_cmpd_file = TRUE,
  client_drug_regex = NA,
  mean_type = "geometric",
  save_text = NA,
  page_orientation = "portrait"
)

Arguments

sim_data_files	name of the Excel file containing the simulator output, in quotes or leave as the default "use existing_exp_details" to get all the files included in the object provided for existing_exp_details.
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".
default_cmpd_file	Was one of the default compound files used for the substrate (if this was a perpetrator simulation) or the perpetrator (if this was a victim simulation)? TRUE (default) or FALSE. The only thing this affects is the sentence in the template report text, "The default compound library file for XXX was used."
client_drug_regex	fill in a string of text that will match your client drug, and that will be used to check whether the client drug is in the substrate position or inhibitor 1 position in the simulation. Which position it is affects the wording of the output text.
mean_type	"arithmetic" or "geometric" (default) means in PK tables
save_text	optionally save the output as a Word document, which is what we recommend, by providing a Word file name here.
page_orientation	set the page orientation for the Word file output to "portrait" (default) or "landscape"

Value

list of study design info for a report and, optionall, a Word document with that info

Examples

none yet

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