From 804a65826dee34539e78e6d9e2e3e2b5d4f1dfe6 Mon Sep 17 00:00:00 2001 From: Philip Delff Date: Thu, 19 Oct 2023 09:31:08 -0400 Subject: [PATCH] documentation --- R/NMdataConf.R | 2 +- R/NMscanData.R | 2 +- man/NMdataConf.Rd | 2 +- man/NMreadSection.Rd | 4 ++-- man/NMscanData.Rd | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/R/NMdataConf.R b/R/NMdataConf.R index 7995f868..80aa64cc 100644 --- a/R/NMdataConf.R +++ b/R/NMdataConf.R @@ -123,7 +123,7 @@ ##' all relevant variables in the output tables. Default is TRUE. ##' ##' \item{use.rds} Deprecated, use \code{formats.read} and -##' \code{formats.write} instead. Affects `code{NMscanData()}, +##' \code{formats.write} instead. Affects \code{NMscanData()}, ##' \code{NMscanInput()}, \code{NMwriteData()}. ##' ##' } diff --git a/R/NMscanData.R b/R/NMscanData.R index 5ff2469c..25610937 100644 --- a/R/NMscanData.R +++ b/R/NMscanData.R @@ -146,7 +146,7 @@ ##' of this can be overcome by using merge.by.row=TRUE. Incomplete ##' list of known limitations: ##' -##' \itemize{ +##' \describe{ ##' \item{character TIME}{If Nonmem is used to translate DAY and a character TIME column, TIME has to be available in an output table. NMscanData does not do the translation to numeric.} ##' \item{RECORDS}{The RECORDS option to limit the part of the input data being used is not searched for. Using merge.by.row=TRUE will work unaffectedly.} ##' \item{NULL}{The NULL argument to specify missing value string in input data is not respected. If delimited input data is read (as opposed to rds files), missing values are assumed to be represented by dots (.).} diff --git a/man/NMdataConf.Rd b/man/NMdataConf.Rd index a97154c6..823aeacb 100644 --- a/man/NMdataConf.Rd +++ b/man/NMdataConf.Rd @@ -123,7 +123,7 @@ Using this, you don't have to worry about remembering including all relevant variables in the output tables. Default is TRUE. \item{use.rds} Deprecated, use \code{formats.read} and -\code{formats.write} instead. Affects `code{NMscanData()}, +\code{formats.write} instead. Affects \code{NMscanData()}, \code{NMscanInput()}, \code{NMwriteData()}. }} diff --git a/man/NMreadSection.Rd b/man/NMreadSection.Rd index a8f39634..8f494380 100644 --- a/man/NMreadSection.Rd +++ b/man/NMreadSection.Rd @@ -94,9 +94,9 @@ suitable for the results part too. } \section{Functions}{ \itemize{ -\item \code{NMgetSection()}: Deprecated function name. Use NMreadSection. - +\item \code{NMgetSection}: Deprecated function name. Use NMreadSection. }} + \examples{ NMreadSection(system.file("examples/nonmem/xgxr001.lst", package="NMdata"),section="DATA") diff --git a/man/NMscanData.Rd b/man/NMscanData.Rd index 823e2be3..3cce9223 100644 --- a/man/NMscanData.Rd +++ b/man/NMscanData.Rd @@ -206,7 +206,7 @@ Limitations. A number of Nonmem features are not supported. Most of this can be overcome by using merge.by.row=TRUE. Incomplete list of known limitations: -\itemize{ +\describe{ \item{character TIME}{If Nonmem is used to translate DAY and a character TIME column, TIME has to be available in an output table. NMscanData does not do the translation to numeric.} \item{RECORDS}{The RECORDS option to limit the part of the input data being used is not searched for. Using merge.by.row=TRUE will work unaffectedly.} \item{NULL}{The NULL argument to specify missing value string in input data is not respected. If delimited input data is read (as opposed to rds files), missing values are assumed to be represented by dots (.).}