diff --git a/R/data_extract.R b/R/data_extract.R index c43c9bcb9..26d7ef4a1 100644 --- a/R/data_extract.R +++ b/R/data_extract.R @@ -1,7 +1,7 @@ #' Extract a single column or element from an object #' -#' `extract()` is similar to `$`. It extracts a single column or element from an object -#' (e.g., a data frame, list, ) +#' `data_extract()` (or its alias `extract()`) is similar to `$`. It extracts a single column or element from an object +#' (e.g., a data frame, list, ). #' #' @param data The object to subset. Methods are currently available for data frames #' and data frame extensions (e.g., tibbles). diff --git a/R/data_rename.R b/R/data_rename.R index bb0669d7a..6d30f4ad9 100644 --- a/R/data_rename.R +++ b/R/data_rename.R @@ -29,7 +29,7 @@ #' - Functions to reorder, find and remove columns: [data_findcols()], [data_reorder()], [data_remove()] #' - Functions to reshape, pivot or rotate dataframes: [data_to_long()], [data_to_wide()], [data_rotate()] #' - Functions to rescale and reverse: [data_rescale()], [data_reverse()] -#' - Functions to standardize, normalize, rank-transform: [standardize()], [normalize()], [ranktransform()] +#' - Functions to standardize, normalize, rank-transform: [standardize()], [normalize()], [ranktransform()], [winsorize()] #' - Split, cut and merge dataframes: [data_partition()], [data_cut()], [data_match()], [data_merge()] #' #' @export diff --git a/R/winsorize.R b/R/winsorize.R index 76b421d25..434775697 100644 --- a/R/winsorize.R +++ b/R/winsorize.R @@ -24,6 +24,7 @@ #' @examples #' winsorize(iris$Sepal.Length, threshold = 0.2) #' winsorize(iris, threshold = 0.2) +#' @inherit data_rename seealso #' @export winsorize <- function(data, ...) { UseMethod("winsorize") diff --git a/man/data_extract.Rd b/man/data_extract.Rd index 91e1fbefb..1c189e371 100644 --- a/man/data_extract.Rd +++ b/man/data_extract.Rd @@ -35,8 +35,8 @@ Specified in the same way as \code{select}.} A vector containing the extracted element. } \description{ -\code{extract()} is similar to \code{$}. It extracts a single column or element from an object -(e.g., a data frame, list, ) +\code{data_extract()} (or its alias \code{extract()}) is similar to \code{$}. It extracts a single column or element from an object +(e.g., a data frame, list, ). } \examples{ extract(mtcars, cyl, name = gear) diff --git a/man/data_match.Rd b/man/data_match.Rd index 0333d4ef6..2493d9a77 100644 --- a/man/data_match.Rd +++ b/man/data_match.Rd @@ -47,7 +47,7 @@ mtcars[matching_rows, ] \item Functions to reorder, find and remove columns: \code{\link[=data_findcols]{data_findcols()}}, \code{\link[=data_reorder]{data_reorder()}}, \code{\link[=data_remove]{data_remove()}} \item Functions to reshape, pivot or rotate dataframes: \code{\link[=data_to_long]{data_to_long()}}, \code{\link[=data_to_wide]{data_to_wide()}}, \code{\link[=data_rotate]{data_rotate()}} \item Functions to rescale and reverse: \code{\link[=data_rescale]{data_rescale()}}, \code{\link[=data_reverse]{data_reverse()}} -\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}} +\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}}, \code{\link[=winsorize]{winsorize()}} \item Split, cut and merge dataframes: \code{\link[=data_partition]{data_partition()}}, \code{\link[=data_cut]{data_cut()}}, \code{\link[=data_match]{data_match()}}, \code{\link[=data_merge]{data_merge()}} } } diff --git a/man/data_merge.Rd b/man/data_merge.Rd index 21bb19c60..3d8447911 100644 --- a/man/data_merge.Rd +++ b/man/data_merge.Rd @@ -185,7 +185,7 @@ data_merge(list(x, y, z), join = "bind", by = "id", id = "source") \item Functions to reorder, find and remove columns: \code{\link[=data_findcols]{data_findcols()}}, \code{\link[=data_reorder]{data_reorder()}}, \code{\link[=data_remove]{data_remove()}} \item Functions to reshape, pivot or rotate dataframes: \code{\link[=data_to_long]{data_to_long()}}, \code{\link[=data_to_wide]{data_to_wide()}}, \code{\link[=data_rotate]{data_rotate()}} \item Functions to rescale and reverse: \code{\link[=data_rescale]{data_rescale()}}, \code{\link[=data_reverse]{data_reverse()}} -\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}} +\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}}, \code{\link[=winsorize]{winsorize()}} \item Split, cut and merge dataframes: \code{\link[=data_partition]{data_partition()}}, \code{\link[=data_cut]{data_cut()}}, \code{\link[=data_match]{data_match()}}, \code{\link[=data_merge]{data_merge()}} } } diff --git a/man/data_partition.Rd b/man/data_partition.Rd index bcb8ae4f1..0b8999301 100644 --- a/man/data_partition.Rd +++ b/man/data_partition.Rd @@ -42,7 +42,7 @@ data_partition(df, group = c("Species", "Smell")) \item Functions to reorder, find and remove columns: \code{\link[=data_findcols]{data_findcols()}}, \code{\link[=data_reorder]{data_reorder()}}, \code{\link[=data_remove]{data_remove()}} \item Functions to reshape, pivot or rotate dataframes: \code{\link[=data_to_long]{data_to_long()}}, \code{\link[=data_to_wide]{data_to_wide()}}, \code{\link[=data_rotate]{data_rotate()}} \item Functions to rescale and reverse: \code{\link[=data_rescale]{data_rescale()}}, \code{\link[=data_reverse]{data_reverse()}} -\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}} +\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}}, \code{\link[=winsorize]{winsorize()}} \item Split, cut and merge dataframes: \code{\link[=data_partition]{data_partition()}}, \code{\link[=data_cut]{data_cut()}}, \code{\link[=data_match]{data_match()}}, \code{\link[=data_merge]{data_merge()}} } } diff --git a/man/data_rename.Rd b/man/data_rename.Rd index 74fc4a1d7..9a56a6d98 100644 --- a/man/data_rename.Rd +++ b/man/data_rename.Rd @@ -56,7 +56,7 @@ head(data_rename(iris, paste0("Var", 1:5))) \item Functions to reorder, find and remove columns: \code{\link[=data_findcols]{data_findcols()}}, \code{\link[=data_reorder]{data_reorder()}}, \code{\link[=data_remove]{data_remove()}} \item Functions to reshape, pivot or rotate dataframes: \code{\link[=data_to_long]{data_to_long()}}, \code{\link[=data_to_wide]{data_to_wide()}}, \code{\link[=data_rotate]{data_rotate()}} \item Functions to rescale and reverse: \code{\link[=data_rescale]{data_rescale()}}, \code{\link[=data_reverse]{data_reverse()}} -\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}} +\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}}, \code{\link[=winsorize]{winsorize()}} \item Split, cut and merge dataframes: \code{\link[=data_partition]{data_partition()}}, \code{\link[=data_cut]{data_cut()}}, \code{\link[=data_match]{data_match()}}, \code{\link[=data_merge]{data_merge()}} } } diff --git a/man/data_reorder.Rd b/man/data_reorder.Rd index 68a57e363..433c80a64 100644 --- a/man/data_reorder.Rd +++ b/man/data_reorder.Rd @@ -47,7 +47,7 @@ head(data_reorder(iris, c("Species", "dupa"))) # Safe for non-existing cols \item Functions to reorder, find and remove columns: \code{\link[=data_findcols]{data_findcols()}}, \code{\link[=data_reorder]{data_reorder()}}, \code{\link[=data_remove]{data_remove()}} \item Functions to reshape, pivot or rotate dataframes: \code{\link[=data_to_long]{data_to_long()}}, \code{\link[=data_to_wide]{data_to_wide()}}, \code{\link[=data_rotate]{data_rotate()}} \item Functions to rescale and reverse: \code{\link[=data_rescale]{data_rescale()}}, \code{\link[=data_reverse]{data_reverse()}} -\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}} +\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}}, \code{\link[=winsorize]{winsorize()}} \item Split, cut and merge dataframes: \code{\link[=data_partition]{data_partition()}}, \code{\link[=data_cut]{data_cut()}}, \code{\link[=data_match]{data_match()}}, \code{\link[=data_merge]{data_merge()}} } } diff --git a/man/data_rotate.Rd b/man/data_rotate.Rd index e9afb2936..e81919674 100644 --- a/man/data_rotate.Rd +++ b/man/data_rotate.Rd @@ -59,7 +59,7 @@ data_rotate(x, colnames = "c") \item Functions to reorder, find and remove columns: \code{\link[=data_findcols]{data_findcols()}}, \code{\link[=data_reorder]{data_reorder()}}, \code{\link[=data_remove]{data_remove()}} \item Functions to reshape, pivot or rotate dataframes: \code{\link[=data_to_long]{data_to_long()}}, \code{\link[=data_to_wide]{data_to_wide()}}, \code{\link[=data_rotate]{data_rotate()}} \item Functions to rescale and reverse: \code{\link[=data_rescale]{data_rescale()}}, \code{\link[=data_reverse]{data_reverse()}} -\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}} +\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}}, \code{\link[=winsorize]{winsorize()}} \item Split, cut and merge dataframes: \code{\link[=data_partition]{data_partition()}}, \code{\link[=data_cut]{data_cut()}}, \code{\link[=data_match]{data_match()}}, \code{\link[=data_merge]{data_merge()}} } } diff --git a/man/data_to_long.Rd b/man/data_to_long.Rd index f7f45480a..b6164966e 100644 --- a/man/data_to_long.Rd +++ b/man/data_to_long.Rd @@ -143,7 +143,7 @@ if (require("psych")) { \item Functions to reorder, find and remove columns: \code{\link[=data_findcols]{data_findcols()}}, \code{\link[=data_reorder]{data_reorder()}}, \code{\link[=data_remove]{data_remove()}} \item Functions to reshape, pivot or rotate dataframes: \code{\link[=data_to_long]{data_to_long()}}, \code{\link[=data_to_wide]{data_to_wide()}}, \code{\link[=data_rotate]{data_rotate()}} \item Functions to rescale and reverse: \code{\link[=data_rescale]{data_rescale()}}, \code{\link[=data_reverse]{data_reverse()}} -\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}} +\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}}, \code{\link[=winsorize]{winsorize()}} \item Split, cut and merge dataframes: \code{\link[=data_partition]{data_partition()}}, \code{\link[=data_cut]{data_cut()}}, \code{\link[=data_match]{data_match()}}, \code{\link[=data_merge]{data_merge()}} } } diff --git a/man/winsorize.Rd b/man/winsorize.Rd index 7a3ad66df..db6474d0a 100644 --- a/man/winsorize.Rd +++ b/man/winsorize.Rd @@ -39,3 +39,13 @@ their more standard forms. winsorize(iris$Sepal.Length, threshold = 0.2) winsorize(iris, threshold = 0.2) } +\seealso{ +\itemize{ +\item Functions to rename stuff: \code{\link[=data_rename]{data_rename()}}, \code{\link[=data_rename_rows]{data_rename_rows()}}, \code{\link[=data_addprefix]{data_addprefix()}}, \code{\link[=data_addsuffix]{data_addsuffix()}} +\item Functions to reorder, find and remove columns: \code{\link[=data_findcols]{data_findcols()}}, \code{\link[=data_reorder]{data_reorder()}}, \code{\link[=data_remove]{data_remove()}} +\item Functions to reshape, pivot or rotate dataframes: \code{\link[=data_to_long]{data_to_long()}}, \code{\link[=data_to_wide]{data_to_wide()}}, \code{\link[=data_rotate]{data_rotate()}} +\item Functions to rescale and reverse: \code{\link[=data_rescale]{data_rescale()}}, \code{\link[=data_reverse]{data_reverse()}} +\item Functions to standardize, normalize, rank-transform: \code{\link[=standardize]{standardize()}}, \code{\link[=normalize]{normalize()}}, \code{\link[=ranktransform]{ranktransform()}}, \code{\link[=winsorize]{winsorize()}} +\item Split, cut and merge dataframes: \code{\link[=data_partition]{data_partition()}}, \code{\link[=data_cut]{data_cut()}}, \code{\link[=data_match]{data_match()}}, \code{\link[=data_merge]{data_merge()}} +} +}