diff --git a/man/add_text_img.Rd b/man/add_text_img.Rd index 69a1cee..fbf083d 100644 --- a/man/add_text_img.Rd +++ b/man/add_text_img.Rd @@ -9,9 +9,18 @@ add_text_img(text, url, height = 30, left = FALSE) \arguments{ \item{text}{A text string to be added to the cell.} -\item{url}{A url that resolves to an image file.} +\item{url}{\emph{An image URL} -\item{height}{The absolute height (px) of the image in the table cell.} +\verb{scalar} // \strong{required} + +A url that resolves to an image file.} + +\item{height}{\emph{Height of image} + +\verb{scalar} // \emph{default:} \code{30} + +The absolute height of the image in the table cell (in \code{"px"} units). By +default, this is set to \code{"30px"}.} \item{left}{A logical TRUE/FALSE indicating if text should be on the left (TRUE) or right (FALSE)} } diff --git a/man/gt_img_multi_rows.Rd b/man/gt_img_multi_rows.Rd index b93b512..5de33c5 100644 --- a/man/gt_img_multi_rows.Rd +++ b/man/gt_img_multi_rows.Rd @@ -13,7 +13,12 @@ gt_img_multi_rows(gt_object, columns, img_source = "web", height = 30) \item{img_source}{A string, specifying either "local" or "web" as the source of the images.} -\item{height}{The absolute height (px) of the image in the table cell.} +\item{height}{\emph{Height of image} + +\verb{scalar} // \emph{default:} \code{30} + +The absolute height of the image in the table cell (in \code{"px"} units). By +default, this is set to \code{"30px"}.} } \value{ An object of class \code{gt_tbl}. diff --git a/man/gt_img_rows.Rd b/man/gt_img_rows.Rd index 165fb96..97329c2 100644 --- a/man/gt_img_rows.Rd +++ b/man/gt_img_rows.Rd @@ -13,7 +13,12 @@ gt_img_rows(gt_object, columns, img_source = "web", height = 30) \item{img_source}{A string, specifying either "local" or "web" as the source of the images.} -\item{height}{The absolute height (px) of the image in the table cell.} +\item{height}{\emph{Height of image} + +\verb{scalar} // \emph{default:} \code{30} + +The absolute height of the image in the table cell (in \code{"px"} units). By +default, this is set to \code{"30px"}.} } \value{ An object of class \code{gt_tbl}. diff --git a/man/gt_plt_dist.Rd b/man/gt_plt_dist.Rd index 5efcffc..d0def86 100644 --- a/man/gt_plt_dist.Rd +++ b/man/gt_plt_dist.Rd @@ -13,7 +13,8 @@ gt_plt_dist( fill_color = "grey", bw = NULL, trim = FALSE, - same_limit = TRUE + same_limit = TRUE, + type_col = NULL ) } \arguments{ @@ -34,6 +35,8 @@ gt_plt_dist( \item{trim}{A logical indicating whether to trim the values in \code{type = "density"} to a slight expansion beyond the observable range. Can help with long tails in \code{density} plots.} \item{same_limit}{A logical indicating that the plots will use the same axis range (\code{TRUE}) or have individual axis ranges (\code{FALSE}).} + +\item{type_col}{A tidyselect column indicating a vector of which \code{type} of plot to make by row. Must be equal to the total number of rows and limited to \code{"boxplot"}, \code{"histogram"}, \code{"rug_strip"} or \code{"density"}.} } \value{ An object of class \code{gt_tbl}. diff --git a/man/gt_theme_538.Rd b/man/gt_theme_538.Rd index 8e3a920..0d2098d 100644 --- a/man/gt_theme_538.Rd +++ b/man/gt_theme_538.Rd @@ -4,12 +4,14 @@ \alias{gt_theme_538} \title{Apply FiveThirtyEight theme to a gt table} \usage{ -gt_theme_538(gt_object, ...) +gt_theme_538(gt_object, ..., quiet = FALSE) } \arguments{ \item{gt_object}{An existing gt table object of class \code{gt_tbl}} \item{...}{Optional additional arguments to \code{gt::table_options()}} + +\item{quiet}{A logical to silence the warning about missing ID} } \value{ An object of class \code{gt_tbl}. diff --git a/man/gt_theme_dot_matrix.Rd b/man/gt_theme_dot_matrix.Rd index ae1981f..5d007ae 100644 --- a/man/gt_theme_dot_matrix.Rd +++ b/man/gt_theme_dot_matrix.Rd @@ -4,7 +4,7 @@ \alias{gt_theme_dot_matrix} \title{Apply dot matrix theme to a gt table} \usage{ -gt_theme_dot_matrix(gt_object, ..., color = "#b5dbb6") +gt_theme_dot_matrix(gt_object, ..., color = "#b5dbb6", quiet = FALSE) } \arguments{ \item{gt_object}{An existing gt table object of class \code{gt_tbl}} @@ -12,6 +12,8 @@ gt_theme_dot_matrix(gt_object, ..., color = "#b5dbb6") \item{...}{Additional arguments passed to \code{gt::tab_options()}} \item{color}{A string indicating the color of the row striping, defaults to a light green. Accepts either named colors or hex colors.} + +\item{quiet}{A logical to silence the warning about missing ID} } \value{ An object of class \code{gt_tbl}. diff --git a/man/plot_data.Rd b/man/plot_data.Rd index 5ecdc35..3f2088a 100644 --- a/man/plot_data.Rd +++ b/man/plot_data.Rd @@ -4,13 +4,15 @@ \alias{plot_data} \title{Create inline plots for a summary table} \usage{ -plot_data(col, col_name, ...) +plot_data(col, col_name, n_missing, ...) } \arguments{ \item{col}{The column of data to be used for plotting} \item{col_name}{the name of the column - use for reporting warnings} +\item{n_missing}{Number of missing - used if all missing} + \item{...}{additional arguments passed to scales::label_number()} } \value{