documentation

R/NMreadPhi.R

@@ -1,24 +1,21 @@
 ##' Read information from Nonmem phi files
 ##'
-##' @param file Path to the phi file. If `auto.ext=TRUE`, the
-##'     extension will automatically be changed using the setting in
-##'     `NMdataConf()$file.fir` - this by default means that the
-##'     `.phi` extension will be used no matter what extension the
-##'     provided file name has.
+##' @param file Path to the phi file. See `auto.ext` too.
 ##' @param as.fun The default is to return data as a data.frame. Pass
 ##'     a function (say tibble::as_tibble) in as.fun to convert to
 ##'     something else. If data.tables are wanted, use
 ##'     as.fun="data.table". The default can be configured using
 ##'     NMdataConf.
 ##' @param modelname See ?NMscanData
 ##' @param col.model See ?NMscanData
-##' @param auto.ext If TRUE (default) the extension will automatically
-##'     be modified using `NMdataConf()$file.phi`. This means `file`
-##'     can be the path to an input or output control stream, and
-##'     `NMreadPhi` will still read the `.phi` file.
+##' @param auto.ext If `auto.ext=TRUE`, the file name extension will
+##'     automatically be changed using the setting in
+##'     `NMdataConf()$file.phi` - this by default means that the
+##'     `.phi` extension will be used no matter what extension the
+##'     provided file name has.
 ##' @param file.phi Deprecated. Use `file`.
-##' 
-##' @return A list with a final parameter table and a table of the iterations
+##' @return A list with a final parameter table and a table of the
+##'     iterations
 ##' @export
 
 NMreadPhi <- function(file,as.fun,modelname,col.model,auto.ext,file.phi){