From 4285a64141f246d20f84d14a4f483985227a74a0 Mon Sep 17 00:00:00 2001 From: Vincent Arel-Bundock Date: Wed, 20 Nov 2024 19:27:03 -0500 Subject: [PATCH] issue #822 document fun_unique in datasummary_skim --- R/datasummary_skim.R | 2 +- man/datasummary_skim.Rd | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/R/datasummary_skim.R b/R/datasummary_skim.R index 5887b4a6..6cdbeabb 100644 --- a/R/datasummary_skim.R +++ b/R/datasummary_skim.R @@ -11,7 +11,7 @@ #' @import data.table #' @param type String. Variables to summarize: "all", "numeric", "categorical", "dataset" #' @param by Character vector of grouping variables to compute statistics over. -#' @param fun_numeric Named list of funtions to apply to each column of `data`. If `fun_numeric` includes "Histogram" or "Density", inline plots are inserted. +#' @param fun_numeric Named list of funtions to apply to each numeric column of `data`. If `fun_numeric` includes "Histogram" or "Density", inline plots are inserted. This argument is only used when `type="numeric"` or `"all"`. #' #' @template kableExtra2tinytable #' @template citation diff --git a/man/datasummary_skim.Rd b/man/datasummary_skim.Rd index c974d2c3..19336f52 100644 --- a/man/datasummary_skim.Rd +++ b/man/datasummary_skim.Rd @@ -71,7 +71,7 @@ prevent the file from compiling/displaying. \code{TRUE} escapes all cells, capti \item{by}{Character vector of grouping variables to compute statistics over.} -\item{fun_numeric}{Named list of funtions to apply to each column of \code{data}. If \code{fun_numeric} includes "Histogram" or "Density", inline plots are inserted.} +\item{fun_numeric}{Named list of funtions to apply to each numeric column of \code{data}. If \code{fun_numeric} includes "Histogram" or "Density", inline plots are inserted. This argument is only used when \code{type="numeric"} or \code{"all"}.} \item{...}{all other arguments are passed through to the table-making functions \link[tinytable:tt]{tinytable::tt}, \link[kableExtra:kbl]{kableExtra::kbl}, \link[gt:gt]{gt::gt}, \link[DT:datatable]{DT::datatable}, etc. depending on the \code{output} argument.