From d79eff1fdcf47b3a9f2f541fdbfabc5213a8727a Mon Sep 17 00:00:00 2001 From: "27856297+dependabot-preview[bot]@users.noreply.github.com" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Tue, 7 Nov 2023 12:33:13 +0000 Subject: [PATCH] [skip actions] Roxygen Man Pages Auto Update --- man/template_g_lineplot.Rd | 12 +++++++----- man/tm_g_lineplot.Rd | 12 +++++++----- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/man/template_g_lineplot.Rd b/man/template_g_lineplot.Rd index 149a4fc47e..5c1e8881b8 100644 --- a/man/template_g_lineplot.Rd +++ b/man/template_g_lineplot.Rd @@ -30,7 +30,7 @@ template_g_lineplot( \item{dataname}{(\code{character})\cr analysis data used in teal module.} -\item{strata}{(\code{character} or \code{NA})\cr strata variable name.} +\item{strata}{(\code{character} or \code{NA})\cr deprecated - group variable name.} \item{x}{(\code{character})\cr x variable name.} @@ -49,11 +49,13 @@ and be of a \code{double} or \code{numeric} type vector of length one.} \item{interval}{(\code{character} or \code{NULL})\cr names of the statistics that will be plotted as intervals. All the statistics indicated in \code{interval} variable must be present in the object returned by \code{sfun}, -and be of a \code{double} or \code{numeric} type vector of length two.} +and be of a \code{double} or \code{numeric} type vector of length two. Set \code{interval = NULL} if intervals should not be +added to the plot.} -\item{whiskers}{(\code{character})\cr names of the interval whiskers that will be plotted. Must match the \code{names} -attribute of the \code{interval} element in the list returned by \code{sfun}. It is possible to specify one whisker only, -lower or upper.} +\item{whiskers}{(\code{character})\cr names of the interval whiskers that will be plotted. Names must match names +of the list element \code{interval} that will be returned by \code{sfun} (e.g. \code{mean_ci_lwr} element of +\code{sfun(x)[["mean_ci"]]}). It is possible to specify one whisker only, or to suppress all whiskers by setting +\code{interval = NULL}.} \item{table}{(\code{character} or \code{NULL})\cr names of the statistics that will be displayed in the table below the plot. All the statistics indicated in \code{table} variable must be present in the object returned by \code{sfun}.} diff --git a/man/tm_g_lineplot.Rd b/man/tm_g_lineplot.Rd index f9949e233a..3e3668beeb 100644 --- a/man/tm_g_lineplot.Rd +++ b/man/tm_g_lineplot.Rd @@ -47,7 +47,7 @@ analysis data used in teal module.} \item{parentname}{(\code{character})\cr parent analysis data used in teal module, usually this refers to \code{ADSL}.} -\item{strata}{(\code{character} or \code{NA})\cr strata variable name.} +\item{strata}{(\code{character} or \code{NA})\cr deprecated - group variable name.} \item{x}{(\code{character})\cr x variable name.} @@ -65,15 +65,17 @@ value for the confidence level within the range of (0, 1).} \item{interval}{(\code{character} or \code{NULL})\cr names of the statistics that will be plotted as intervals. All the statistics indicated in \code{interval} variable must be present in the object returned by \code{sfun}, -and be of a \code{double} or \code{numeric} type vector of length two.} +and be of a \code{double} or \code{numeric} type vector of length two. Set \code{interval = NULL} if intervals should not be +added to the plot.} \item{mid}{(\code{character} or \code{NULL})\cr names of the statistics that will be plotted as midpoints. All the statistics indicated in \code{mid} variable must be present in the object returned by \code{sfun}, and be of a \code{double} or \code{numeric} type vector of length one.} -\item{whiskers}{(\code{character})\cr names of the interval whiskers that will be plotted. Must match the \code{names} -attribute of the \code{interval} element in the list returned by \code{sfun}. It is possible to specify one whisker only, -lower or upper.} +\item{whiskers}{(\code{character})\cr names of the interval whiskers that will be plotted. Names must match names +of the list element \code{interval} that will be returned by \code{sfun} (e.g. \code{mean_ci_lwr} element of +\code{sfun(x)[["mean_ci"]]}). It is possible to specify one whisker only, or to suppress all whiskers by setting +\code{interval = NULL}.} \item{table}{(\code{character} or \code{NULL})\cr names of the statistics that will be displayed in the table below the plot. All the statistics indicated in \code{table} variable must be present in the object returned by \code{sfun}.}