From 4d449d342a08c6bcec59d3f6364588344a9e8a8c Mon Sep 17 00:00:00 2001 From: Niklas Hohmann <67792281+NiklasHohmann@users.noreply.github.com> Date: Wed, 11 Sep 2024 14:50:13 +0200 Subject: [PATCH] expand documentation --- man/mean_adm.Rd | 3 +++ man/median_adm.Rd | 3 +++ man/quantile_adm.Rd | 5 ++++- 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/man/mean_adm.Rd b/man/mean_adm.Rd index 22c1b7b..a848bab 100644 --- a/man/mean_adm.Rd +++ b/man/mean_adm.Rd @@ -17,3 +17,6 @@ an adm object \description{ returns the mean adm of a multiadm object } +\seealso{ +\code{\link[=median_adm]{median_adm()}} and \code{\link[=quantile_adm]{quantile_adm()}} for median and quantile adms, respectively +} diff --git a/man/median_adm.Rd b/man/median_adm.Rd index 7f00f42..2262555 100644 --- a/man/median_adm.Rd +++ b/man/median_adm.Rd @@ -17,3 +17,6 @@ an adm object \description{ returns the median adm of a multiadm object } +\seealso{ +\code{\link[=mean_adm]{mean_adm()}} for the mean age-depth model, \code{\link[=quantile_adm]{quantile_adm()}} for the more general implementation +} diff --git a/man/quantile_adm.Rd b/man/quantile_adm.Rd index 3f6f29d..0af21ab 100644 --- a/man/quantile_adm.Rd +++ b/man/quantile_adm.Rd @@ -11,7 +11,7 @@ quantile_adm(x, h, p) \item{h}{the heights at which to evaluate the adm} -\item{p}{percentile} +\item{p}{percentile, as number between 0 and 1} } \value{ an adm object @@ -19,3 +19,6 @@ an adm object \description{ returns the quantile adm of a multiadm object } +\seealso{ +\code{\link[=median_adm]{median_adm()}} to extract the median adm, \code{\link[=mean_adm]{mean_adm()}} for the mean adm +}