Print parameters for an R function of interest in console

Usage

forgot_params(pkg, function_name, write = FALSE)

Arguments

pkg: string with installed R package name
function_name: function name in R package
write: logical write to RStudio rmd file, FALSE by default

Examples

forgot_params("dplyr", "count")
#> x A data frame, data frame extension (e.g. a tibble), or a
#> lazy data frame (e.g. from dbplyr or dtplyr).
#> ------
#> ... <\code{\link[rlang:args_data_masking]{data-masking}}> Variables to group
#> by.
#> ------
#> wt <\code{\link[rlang:args_data_masking]{data-masking}}> Frequency weights.
#> Can be \code{NULL} or a variable:
#> \itemize{
#> \item If \code{NULL} (the default), counts the number of rows in each group.
#> \item If a variable, computes \code{sum(wt)} for each group.
#> }
#> ------
#> sort If \code{TRUE}, will show the largest groups at the top.
#> ------
#> name The name of the new column in the output.
#> 
#> If omitted, it will default to \code{n}. If there's already a column called \code{n},
#> it will use \code{nn}. If there's a column called \code{n} and \code{nn}, it'll use
#> \code{nnn}, and so on, adding \code{n}s until it gets a new name.
#> ------
#> .drop Handling of factor levels that don't appear in the data, passed
#> on to \code{\link[=group_by]{group_by()}}.
#> 
#> For \code{count()}: if \code{FALSE} will include counts for empty groups (i.e. for
#> levels of factors that don't exist in the data).
#> 
#> \ifelse{html\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated\figure{lifecycle-deprecated.svgoptions: alt='[Deprecated]'}}\strong{[Deprecated]}} For \code{add_count()}: deprecated since it
#> can't actually affect the output.
forgot_params(dplyr, count)
#> x A data frame, data frame extension (e.g. a tibble), or a
#> lazy data frame (e.g. from dbplyr or dtplyr).
#> ------
#> ... <\code{\link[rlang:args_data_masking]{data-masking}}> Variables to group
#> by.
#> ------
#> wt <\code{\link[rlang:args_data_masking]{data-masking}}> Frequency weights.
#> Can be \code{NULL} or a variable:
#> \itemize{
#> \item If \code{NULL} (the default), counts the number of rows in each group.
#> \item If a variable, computes \code{sum(wt)} for each group.
#> }
#> ------
#> sort If \code{TRUE}, will show the largest groups at the top.
#> ------
#> name The name of the new column in the output.
#> 
#> If omitted, it will default to \code{n}. If there's already a column called \code{n},
#> it will use \code{nn}. If there's a column called \code{n} and \code{nn}, it'll use
#> \code{nnn}, and so on, adding \code{n}s until it gets a new name.
#> ------
#> .drop Handling of factor levels that don't appear in the data, passed
#> on to \code{\link[=group_by]{group_by()}}.
#> 
#> For \code{count()}: if \code{FALSE} will include counts for empty groups (i.e. for
#> levels of factors that don't exist in the data).
#> 
#> \ifelse{html\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated\figure{lifecycle-deprecated.svgoptions: alt='[Deprecated]'}}\strong{[Deprecated]}} For \code{add_count()}: deprecated since it
#> can't actually affect the output.
if (FALSE) { # \dontrun{
forgot_params(dplyr, count, write = TRUE)
} # }