metaInit: Initialise a metadata object based

In philipdelff/pmxtricks: Every-day pharmacometrics helper functions

Initialise a metadata object based

Description

Create a metadata object based on a dataset and some initial information. A metadata object is a list containing information about variables in a dataset plus some more information such as what dataset is being described, what study it is part of etc.

Usage

metaInit(
  data,
  stamp,
  analysis = NULL,
  header = NULL,
  use.standard.cols = T,
  time.unit = "h",
  dv.unit = NULL,
  amt.unit = NULL,
  ndos.unit = NULL,
  debug = F
)

Arguments

data	The dataset being described (i.e. a data.frame).
stamp	The path to the script that is creating the data.
analysis	The name of the analysis (character). This could be a trial name or any another character string.
header	Append lines to the header of the meta data.
use.standard.cols	The name is slightly misleading. If FALSE, only the header will be created. That means that unit arguments will have no effect.
time.unit	The unit of time columns in data. Default is "h" for hours.
dv.unit	If supplied, the unit for DV will be taken from here. a column called dv.unit will be ignored.
amt.unit	If supplied, the unit for AMT will be taken from here. a column called amt.unit will be ignored.
ndos.unit	If supplied, the unit for NDOS will be taken from here.
debug	Start by calling browser()?

Value

Created meta data object

See Also

Other DataGen: metaCheck(), metaPrint()

philipdelff/pmxtricks documentation built on Nov. 11, 2024, 5:16 p.m.