Skip to content

Commit

Permalink
add examples for all funcs
Browse files Browse the repository at this point in the history
  • Loading branch information
nrennie committed Nov 17, 2024
1 parent e9811a6 commit 4cb3e72
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 1 deletion.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
Config/Needs/website: nrennie/nrenniepkgdown
URL: http://nrennie.rbind.io/messy, https://github.com/nrennie/messy
URL: https://nrennie.rbind.io/messy, https://github.com/nrennie/messy
BugReports: https://github.com/nrennie/messy/issues
2 changes: 2 additions & 0 deletions R/add_whitespace.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
#' between 0 and 1. Default 0.1.
#' @return a dataframe the same size as the input data.
#' @export
#' @examples
#' add_whitespace(mtcars)

add_whitespace <- function(data, cols = NULL, messiness = 0.1) {
if (messiness < 0 || messiness > 1) {
Expand Down
2 changes: 2 additions & 0 deletions R/change_case.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
#' @importFrom rlang .data
#' @return a dataframe the same size as the input data.
#' @export
#' @examples
#' change_case(mtcars)

change_case <- function(data,
cols = NULL,
Expand Down
2 changes: 2 additions & 0 deletions R/make_missing.R
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
#' Default `NA`.
#' @return a dataframe the same size as the input data.
#' @export
#' @examples
#' make_missing(mtcars)

make_missing <- function(data,
cols = NULL,
Expand Down
2 changes: 2 additions & 0 deletions R/messy.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
#' the `"word"` or `"letter"`.
#' @return a dataframe the same size as the input data.
#' @export
#' @examples
#' messy(mtcars)

messy <- function(data,
messiness = 0.1,
Expand Down
3 changes: 3 additions & 0 deletions man/add_whitespace.Rd

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

3 changes: 3 additions & 0 deletions man/change_case.Rd

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

3 changes: 3 additions & 0 deletions man/make_missing.Rd

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

3 changes: 3 additions & 0 deletions man/messy.Rd

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

0 comments on commit 4cb3e72

Please sign in to comment.