Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
philipdelff committed Jan 18, 2025
1 parent 350faae commit fed5afc
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 10 deletions.
1 change: 1 addition & 0 deletions R/NMcheckData.R
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,7 @@ NMcheckData <- function(data,file,covs,covs.occ,cols.num,col.id="ID",
level <- NULL
MDVDV <- NULL
MDV <- NULL
N <- NULL
newID <- NULL
NidByUID <- NULL
Nids <- NULL
Expand Down
10 changes: 6 additions & 4 deletions R/NMreadInits.R
Original file line number Diff line number Diff line change
Expand Up @@ -208,13 +208,15 @@ count_ij <- function(res){
##' @param lines A control stream as text lines. Use this or `file`.
##' @param section The section to read. Typically, "theta", "omega",
##' or "sigma". Default is those three.
##' @param as.fun See ?NMscanData
##' @return By default (when \code{return="pars"}, a parameter table
##' with initial values, FIX, lower and upper bounds etc. In most
##' cases, that is what is needed to derive information about
##' @param return By default (when \code{return="pars"}, a parameter
##' table with initial values, FIX, lower and upper bounds etc. In
##' most cases, that is what is needed to derive information about
##' parameter definitions. If \code{return="all"}, two additional
##' tables are returned which can be used if the aim is to modify
##' and write the resulting parameters to a control stream.
##' @param as.fun See ?NMscanData
##' @return A `data.frame` with parameter values. If `return="all"`, a
##' list of three tables.
##' @export
NMreadInits <- function(file,lines,section,return="pars",as.fun) {

Expand Down
15 changes: 9 additions & 6 deletions man/NMreadInits.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fed5afc

Please sign in to comment.