From 9524aaf329c6d8190276553757c2c2bbfd49b10e Mon Sep 17 00:00:00 2001 From: Daniel Date: Tue, 21 May 2024 14:29:36 +0200 Subject: [PATCH] docs --- R/data_to_long.R | 2 +- man/coef_var.Rd | 4 ---- man/data_to_long.Rd | 2 +- 3 files changed, 2 insertions(+), 6 deletions(-) diff --git a/R/data_to_long.R b/R/data_to_long.R index 9e0d49f73..e4ca2119e 100644 --- a/R/data_to_long.R +++ b/R/data_to_long.R @@ -5,7 +5,7 @@ #' `tidyr::pivot_longer()`. #' #' @param data A data frame to convert to long format, so that it has more -#' rows and fewer columns post-lengthening than pre-lengthening. +#' rows and fewer columns after the operation. #' @param names_to The name of the new column (variable) that will contain the #' _names_ from columns in `select` as values, to identify the source of the #' values. diff --git a/man/coef_var.Rd b/man/coef_var.Rd index 0f0965076..92274ca59 100644 --- a/man/coef_var.Rd +++ b/man/coef_var.Rd @@ -79,14 +79,10 @@ This means that CV is \strong{NOT} invariant to shifting, but it is to scaling: \if{html}{\out{
}}\preformatted{sandwiches <- c(0, 4, 15, 0, 0, 5, 2, 7) coef_var(sandwiches) #> [1] 1.239094 -}\if{html}{\out{
}} -\if{html}{\out{
}}\preformatted{ coef_var(sandwiches / 2) # same #> [1] 1.239094 -}\if{html}{\out{
}} -\if{html}{\out{
}}\preformatted{ coef_var(sandwiches + 4) # different! 0 is no longer meaningful! #> [1] 0.6290784 }\if{html}{\out{
}} diff --git a/man/data_to_long.Rd b/man/data_to_long.Rd index 868b26ef2..3de75fe00 100644 --- a/man/data_to_long.Rd +++ b/man/data_to_long.Rd @@ -39,7 +39,7 @@ reshape_longer( } \arguments{ \item{data}{A data frame to convert to long format, so that it has more -rows and fewer columns post-lengthening than pre-lengthening.} +rows and fewer columns after the operation.} \item{select}{Variables that will be included when performing the required tasks. Can be either