get_rmd_str: 'get_rmd_str' returns a Rmd template string, based on the...

Description Usage Arguments Value

View source: R/xgx_auto_explore.R

Description

get_rmd_str returns a Rmd template string, based on the desired PKPD parameters

Usage

1
2
3
4
5
6
7
get_rmd_str(
  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


xgxr documentation built on April 23, 2021, 1:07 a.m.