From 90fa05d1a0815f06db64b1c5fd043d7e1ea1db22 Mon Sep 17 00:00:00 2001 From: unknown Date: Thu, 12 Oct 2023 16:26:50 +0530 Subject: [PATCH] replacing Rd file --- man/report_card_template.Rd | 45 ----------------------------- man/report_card_template_goshawk.Rd | 9 ++++++ 2 files changed, 9 insertions(+), 45 deletions(-) delete mode 100644 man/report_card_template.Rd diff --git a/man/report_card_template.Rd b/man/report_card_template.Rd deleted file mode 100644 index 83f10769..00000000 --- a/man/report_card_template.Rd +++ /dev/null @@ -1,45 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils.R -\name{report_card_template_goshawk} -\alias{report_card_template_goshawk} -\title{Template function to generate reporter card for \code{teal.goshawk}} -\usage{ -report_card_template_goshawk( - title, - label, - with_filter, - filter_panel_api, - constraint_list, - constraint_description = NULL, - style = "default" -) -} -\arguments{ -\item{title}{(\code{character(1)}) title of the card (unless overwritten by label)} - -\item{label}{(\code{character(1)}) label provided by the user when adding the card} - -\item{with_filter}{(\code{logical(1)}) flag indicating to add filter state} - -\item{filter_panel_api}{(\code{FilterPanelAPI}) object with API that allows the generation -of the filter state in the report} - -\item{constraint_list}{(\code{list}) a list containing constraint variables, including: -\itemize{ -\item constraint_var (\code{character(1)}) the constraint variable name. -\item constraint_range_min (\code{numeric(1)}) the minimum constraint range value. -\item constraint_range_max (\code{numeric(1)}) the maximum constraint range value. -}} - -\item{constraint_description}{(\code{character(1)}) description of the constraints.} - -\item{style}{(\code{character(1)}) style of the constraint text block. -options: \code{default}, \code{verbatim} (default is \code{default}).} -} -\value{ -(\code{TealReportCard}) populated with a title, description, and filter state -} -\description{ -Template function to generate reporter card for \code{teal.goshawk} -} -\keyword{internal} diff --git a/man/report_card_template_goshawk.Rd b/man/report_card_template_goshawk.Rd index 61327193..83f10769 100644 --- a/man/report_card_template_goshawk.Rd +++ b/man/report_card_template_goshawk.Rd @@ -15,6 +15,15 @@ report_card_template_goshawk( ) } \arguments{ +\item{title}{(\code{character(1)}) title of the card (unless overwritten by label)} + +\item{label}{(\code{character(1)}) label provided by the user when adding the card} + +\item{with_filter}{(\code{logical(1)}) flag indicating to add filter state} + +\item{filter_panel_api}{(\code{FilterPanelAPI}) object with API that allows the generation +of the filter state in the report} + \item{constraint_list}{(\code{list}) a list containing constraint variables, including: \itemize{ \item constraint_var (\code{character(1)}) the constraint variable name.