get_rmd_name {xgxr} | R Documentation |
Determine the name of a Rmd template
Description
get_rmd_name
returns a name for an Rmd template, based on the desired PKPD parameters
Usage
get_rmd_name(
rmd_template_name = NULL,
multiple_dosing = FALSE,
pk_cmt = NULL,
pd_cmt = NULL,
pd_data_type = NULL
)
Arguments
rmd_template_name |
A custom output name for the generated Rmd file |
multiple_dosing |
if FALSE use single ascending dose template, if TRUE use multiple |
pk_cmt |
An integer denoting the "compartment" containing the PK data. The "CMT" column will typically have these integers, where each row may contain either PK or PD data, potentially of different types (continuous, ordinal, etc.) |
pd_cmt |
An integer denoting the "compartment" containing the PD data, of the desired type (continuous, ordinal, etc.). The "CMT" column will typically have these integers, where each row may contain either PK or PD data |
pd_data_type |
The type of PD data - acceptable values exist in the following list: ["binary","continuous","count","ordinal","real_example","receptor_occupancy","time_to_event"] |
Value
a string for the Rmd template name