Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
strengejacke committed Dec 13, 2024
1 parent 11036bb commit 7ee80ca
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 2 deletions.
5 changes: 5 additions & 0 deletions R/data_rename.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#' @title Rename columns and variable names
#' @name data_rename
#'
#' @description Safe and intuitive functions to rename variables or rows in
#' data frames. `data_rename()` will rename column names, i.e. it facilitates
Expand Down Expand Up @@ -47,6 +48,10 @@
#' `select` can also be a named character vector. In this case, the names are
#' used to rename the columns in the output data frame. See 'Examples'.
#'
#' `data_rename()` also works with list-inputs, but in this case, `select` must
#' be a character vector with valid names. It is not possible to use
#' select-helpers when `data` is a list.
#'
#' @return A modified data frame.
#'
#' @examples
Expand Down
4 changes: 3 additions & 1 deletion R/data_rescale.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
#' Rescale Variables to a New Range
#' @title Rescale Variables to a New Range
#' @name rescale
#'
#' @description
#' Rescale variables to a new range. Can also be used to reverse-score variables
#' (change the keying/scoring direction), or to expand a range.
#'
Expand Down
4 changes: 3 additions & 1 deletion R/data_to_long.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
#' Reshape (pivot) data from wide to long
#' @title Reshape (pivot) data from wide to long
#' @name data_to_long
#'
#' @description
#' This function "lengthens" data, increasing the number of rows and decreasing
#' the number of columns. This is a dependency-free base-R equivalent of
#' `tidyr::pivot_longer()`.
Expand Down
4 changes: 4 additions & 0 deletions man/data_rename.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions man/rescale.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7ee80ca

Please sign in to comment.