From d3c3e4632df340383bbfe98da07ceb244f225be1 Mon Sep 17 00:00:00 2001 From: Matthew Fidler Date: Sat, 12 Oct 2024 15:47:44 -0500 Subject: [PATCH] Add blank ini doc --- man/dot-rxBlankIni.Rd | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 man/dot-rxBlankIni.Rd diff --git a/man/dot-rxBlankIni.Rd b/man/dot-rxBlankIni.Rd new file mode 100644 index 000000000..2f4bf5715 --- /dev/null +++ b/man/dot-rxBlankIni.Rd @@ -0,0 +1,40 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/err.R +\name{.rxBlankIni} +\alias{.rxBlankIni} +\title{Get a blank, theta1, or eta1 initialization block for iniDf} +\usage{ +.rxBlankIni(type = c("emtpy", "theta", "eta")) +} +\arguments{ +\item{type}{type of initialization block to return} +} +\value{ +A data.frame with the appropriate number/type of columns. + +For type="empty", the data.frame will have 0 rows but all the correct types. + +For type="theta", the data.frame will have 1 row with the correct +types and default values. The "name" and "est" will likely need to +be updated. + +For type="eta", the data.frame will have 1 row with the correct +types and default values for the a single eta being added. The +"name" and "est" will likely need to be updated. +} +\description{ +Get a blank, theta1, or eta1 initialization block for iniDf +} +\examples{ + +.rxBlankIni("empty") + +.rxBlankIni("theta") + +.rxBlankIni("eta") + +} +\author{ +Matthew L. Fidler +} +\keyword{internal}