Fetches Details About Data Requirements — NCA_fetch_data

Use this to get information about data formats.

Usage

NCA_fetch_data_format(
  MOD_yaml_file = system.file(package = "ruminate", "templates", "NCA.yaml")
)

Arguments

MOD_yaml_file: Module configuration file with MC as main section.

Value

List with details about the data formats

Examples

NCA_fetch_data_format()
#>   sname              Column Required
#> 1    id          Subject ID      yes
#> 2  time                Time      yes
#> 3 ntime        Nominal Time      yes
#> 4  conc       Concentration      yes
#> 5  dose                Dose      yes
#> 6 route               Route      yes
#> 7   dur Duration (optional)       no
#> 8 cycle          Dose cycle      yes
#>                                                                                                                          Description
#> 1                                                                                                         Unique subject identifier.
#> 2                                                                                        Time since the first dose. Must be numeric.
#> 3                                                       Time since the last dose in the cycle (same units as Time). Must be numeric.
#> 4                                          Observed concentration. Must be numeric, no NA values. Missing values should be set to 0.
#> 5                                                                                             Value of dose given (must be numeric).
#> 6 Doseing route. It should be either 'extravascular' or 'intravascular' but ruminate will make an effort to figure out other values.
#> 7                                                 Doseing duration (same units as Time). If set to N/A a value of 0 will be assumed.
#> 8                                                                                                                 Current dose cycle