From 9e82dec4bb75147e8630e61771a3b849a7c42c0e Mon Sep 17 00:00:00 2001 From: athowes Date: Sat, 16 Nov 2024 12:01:32 +0000 Subject: [PATCH] Document --- man/dot-add_dpar_info.Rd | 5 +++-- man/epidist.Rd | 5 +++-- man/epidist.default.Rd | 7 ++++--- man/epidist_family.Rd | 7 ++++--- man/epidist_family_prior.Rd | 5 +++-- man/epidist_family_prior.default.Rd | 5 +++-- man/epidist_family_prior.lognormal.Rd | 5 +++-- man/epidist_family_reparam.Rd | 5 +++-- man/epidist_family_reparam.default.Rd | 5 +++-- man/epidist_family_reparam.gamma.Rd | 5 +++-- man/reexports.Rd | 21 +++++++++++++++++++++ 11 files changed, 53 insertions(+), 22 deletions(-) create mode 100644 man/reexports.Rd diff --git a/man/dot-add_dpar_info.Rd b/man/dot-add_dpar_info.Rd index 444cbbc75..ac4460d66 100644 --- a/man/dot-add_dpar_info.Rd +++ b/man/dot-add_dpar_info.Rd @@ -10,8 +10,9 @@ \item{family}{A description of the response distribution and link function to be used in the model. Every family function has a link argument allowing users to specify the link function to be applied on the response variable. -If not specified, default links are used. For details of supported families -see \code{\link[=brmsfamily]{brmsfamily()}}.} +If not specified, default links are used. For details of all supported +families see \code{\link[=brmsfamily]{brmsfamily()}}. Commonly used, such as \code{\link[=lognormal]{lognormal()}}, are also +reexported as part of \code{epidist}.} } \description{ Includes additional information (link functions and parameter bound) about diff --git a/man/epidist.Rd b/man/epidist.Rd index f6663d66c..a9a4ab7c0 100644 --- a/man/epidist.Rd +++ b/man/epidist.Rd @@ -18,8 +18,9 @@ parameters.} \item{family}{A description of the response distribution and link function to be used in the model. Every family function has a link argument allowing users to specify the link function to be applied on the response variable. -If not specified, default links are used. For details of supported families -see \code{\link[=brmsfamily]{brmsfamily()}}.} +If not specified, default links are used. For details of all supported +families see \code{\link[=brmsfamily]{brmsfamily()}}. Commonly used, such as \code{\link[=lognormal]{lognormal()}}, are also +reexported as part of \code{epidist}.} \item{prior}{One or more \code{brmsprior} objects created by \code{\link[brms:set_prior]{brms::set_prior()}} or related functions. These priors are passed to \code{\link[=epidist_prior]{epidist_prior()}} in the diff --git a/man/epidist.default.Rd b/man/epidist.default.Rd index 18353ca08..3de4f4b8f 100644 --- a/man/epidist.default.Rd +++ b/man/epidist.default.Rd @@ -7,7 +7,7 @@ \method{epidist}{default}( data, formula = mu ~ 1, - family = "lognormal", + family = lognormal(), prior = NULL, fn = brms::brm, ... @@ -25,8 +25,9 @@ parameters.} \item{family}{A description of the response distribution and link function to be used in the model. Every family function has a link argument allowing users to specify the link function to be applied on the response variable. -If not specified, default links are used. For details of supported families -see \code{\link[=brmsfamily]{brmsfamily()}}.} +If not specified, default links are used. For details of all supported +families see \code{\link[=brmsfamily]{brmsfamily()}}. Commonly used, such as \code{\link[=lognormal]{lognormal()}}, are also +reexported as part of \code{epidist}.} \item{prior}{One or more \code{brmsprior} objects created by \code{\link[brms:set_prior]{brms::set_prior()}} or related functions. These priors are passed to \code{\link[=epidist_prior]{epidist_prior()}} in the diff --git a/man/epidist_family.Rd b/man/epidist_family.Rd index bb4bdc615..ba7960fc7 100644 --- a/man/epidist_family.Rd +++ b/man/epidist_family.Rd @@ -4,7 +4,7 @@ \alias{epidist_family} \title{Define \code{epidist} family} \usage{ -epidist_family(data, family = "lognormal", ...) +epidist_family(data, family = lognormal(), ...) } \arguments{ \item{data}{A \code{data.frame} containing line list data.} @@ -12,8 +12,9 @@ epidist_family(data, family = "lognormal", ...) \item{family}{A description of the response distribution and link function to be used in the model. Every family function has a link argument allowing users to specify the link function to be applied on the response variable. -If not specified, default links are used. For details of supported families -see \code{\link[=brmsfamily]{brmsfamily()}}.} +If not specified, default links are used. For details of all supported +families see \code{\link[=brmsfamily]{brmsfamily()}}. Commonly used, such as \code{\link[=lognormal]{lognormal()}}, are also +reexported as part of \code{epidist}.} \item{...}{Additional arguments passed to \code{fn} method.} } diff --git a/man/epidist_family_prior.Rd b/man/epidist_family_prior.Rd index 82ce122dd..48344ce2b 100644 --- a/man/epidist_family_prior.Rd +++ b/man/epidist_family_prior.Rd @@ -10,8 +10,9 @@ epidist_family_prior(family, ...) \item{family}{A description of the response distribution and link function to be used in the model. Every family function has a link argument allowing users to specify the link function to be applied on the response variable. -If not specified, default links are used. For details of supported families -see \code{\link[=brmsfamily]{brmsfamily()}}.} +If not specified, default links are used. For details of all supported +families see \code{\link[=brmsfamily]{brmsfamily()}}. Commonly used, such as \code{\link[=lognormal]{lognormal()}}, are also +reexported as part of \code{epidist}.} \item{...}{Additional arguments passed to \code{fn} method.} } diff --git a/man/epidist_family_prior.default.Rd b/man/epidist_family_prior.default.Rd index eb2677626..3139ac0a4 100644 --- a/man/epidist_family_prior.default.Rd +++ b/man/epidist_family_prior.default.Rd @@ -10,8 +10,9 @@ \item{family}{A description of the response distribution and link function to be used in the model. Every family function has a link argument allowing users to specify the link function to be applied on the response variable. -If not specified, default links are used. For details of supported families -see \code{\link[=brmsfamily]{brmsfamily()}}.} +If not specified, default links are used. For details of all supported +families see \code{\link[=brmsfamily]{brmsfamily()}}. Commonly used, such as \code{\link[=lognormal]{lognormal()}}, are also +reexported as part of \code{epidist}.} \item{formula}{An object of class \link[stats:formula]{stats::formula} or \link[brms:brmsformula]{brms::brmsformula} (or one that can be coerced to those classes). A symbolic description of the diff --git a/man/epidist_family_prior.lognormal.Rd b/man/epidist_family_prior.lognormal.Rd index 2708ba9ff..2830dd82e 100644 --- a/man/epidist_family_prior.lognormal.Rd +++ b/man/epidist_family_prior.lognormal.Rd @@ -10,8 +10,9 @@ \item{family}{A description of the response distribution and link function to be used in the model. Every family function has a link argument allowing users to specify the link function to be applied on the response variable. -If not specified, default links are used. For details of supported families -see \code{\link[=brmsfamily]{brmsfamily()}}.} +If not specified, default links are used. For details of all supported +families see \code{\link[=brmsfamily]{brmsfamily()}}. Commonly used, such as \code{\link[=lognormal]{lognormal()}}, are also +reexported as part of \code{epidist}.} \item{formula}{An object of class \link[stats:formula]{stats::formula} or \link[brms:brmsformula]{brms::brmsformula} (or one that can be coerced to those classes). A symbolic description of the diff --git a/man/epidist_family_reparam.Rd b/man/epidist_family_reparam.Rd index 27ecba0a4..13a39547b 100644 --- a/man/epidist_family_reparam.Rd +++ b/man/epidist_family_reparam.Rd @@ -10,8 +10,9 @@ epidist_family_reparam(family, ...) \item{family}{A description of the response distribution and link function to be used in the model. Every family function has a link argument allowing users to specify the link function to be applied on the response variable. -If not specified, default links are used. For details of supported families -see \code{\link[=brmsfamily]{brmsfamily()}}.} +If not specified, default links are used. For details of all supported +families see \code{\link[=brmsfamily]{brmsfamily()}}. Commonly used, such as \code{\link[=lognormal]{lognormal()}}, are also +reexported as part of \code{epidist}.} \item{...}{Additional arguments passed to \code{fn} method.} } diff --git a/man/epidist_family_reparam.default.Rd b/man/epidist_family_reparam.default.Rd index 4fc4531de..8ab4d39ce 100644 --- a/man/epidist_family_reparam.default.Rd +++ b/man/epidist_family_reparam.default.Rd @@ -10,8 +10,9 @@ \item{family}{A description of the response distribution and link function to be used in the model. Every family function has a link argument allowing users to specify the link function to be applied on the response variable. -If not specified, default links are used. For details of supported families -see \code{\link[=brmsfamily]{brmsfamily()}}.} +If not specified, default links are used. For details of all supported +families see \code{\link[=brmsfamily]{brmsfamily()}}. Commonly used, such as \code{\link[=lognormal]{lognormal()}}, are also +reexported as part of \code{epidist}.} \item{...}{Additional arguments passed to \code{fn} method.} } diff --git a/man/epidist_family_reparam.gamma.Rd b/man/epidist_family_reparam.gamma.Rd index 70acfa454..090cae603 100644 --- a/man/epidist_family_reparam.gamma.Rd +++ b/man/epidist_family_reparam.gamma.Rd @@ -10,8 +10,9 @@ \item{family}{A description of the response distribution and link function to be used in the model. Every family function has a link argument allowing users to specify the link function to be applied on the response variable. -If not specified, default links are used. For details of supported families -see \code{\link[=brmsfamily]{brmsfamily()}}.} +If not specified, default links are used. For details of all supported +families see \code{\link[=brmsfamily]{brmsfamily()}}. Commonly used, such as \code{\link[=lognormal]{lognormal()}}, are also +reexported as part of \code{epidist}.} \item{...}{Additional arguments passed to \code{fn} method.} } diff --git a/man/reexports.Rd b/man/reexports.Rd new file mode 100644 index 000000000..afd1c9f79 --- /dev/null +++ b/man/reexports.Rd @@ -0,0 +1,21 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/reexports.R +\docType{import} +\name{reexports} +\alias{reexports} +\alias{lognormal} +\alias{weibull} +\alias{Gamma} +\alias{bf} +\title{Objects exported from other packages} +\keyword{internal} +\description{ +These objects are imported from other packages. Follow the links +below to see their documentation. + +\describe{ + \item{brms}{\code{\link[brms:brmsformula]{bf}}, \code{\link[brms:brmsfamily]{lognormal}}, \code{\link[brms:brmsfamily]{weibull}}} + + \item{stats}{\code{\link[stats:family]{Gamma}}} +}} +