Skip to content

Commit

Permalink
change to _PACKAGE, update descriptive text
Browse files Browse the repository at this point in the history
  • Loading branch information
sfirke committed Aug 19, 2023
1 parent b2700cf commit 81a2404
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 48 deletions.
29 changes: 12 additions & 17 deletions R/janitor.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,23 @@
#' janitor has simple little tools for examining and cleaning dirty data.
#'
#' @section Main functions:
#' The main janitor functions can: perfectly format ugly `data.frame` column names; isolate
#' duplicate records for further study; and provide quick one- and two-variable tabulations
#' (i.e., frequency tables and crosstabs) that improve on the base R function `table()`.
#'
#'
#' Other functions in the package can format for reporting the results of these tabulations.
#' These tabulate-and-report functions approximate popular features of SPSS and Microsoft Excel.
#' The main janitor functions can: perfectly format data.frame
#' column names; provide quick counts of variable combinations (i.e.,
#' frequency tables and crosstabs); and explore duplicate records. Other
#' janitor functions nicely format the tabulation results. These
#' tabulate-and-report functions approximate popular features of SPSS and
#' Microsoft Excel.
#'
#' @section Package context:
#' This package follows the principles of the "tidyverse" and in particular works well with
#' the `\%>\%` pipe function.
#'
#' This package follows the principles of the "tidyverse" and works
#' well with the pipe function `\%>\%`.
#'
#' janitor was built with beginning-to-intermediate R users in mind
#' and is optimized for user-friendliness. Advanced users can already do everything
#' covered here, but they can do it faster with janitor and save their thinking for
#' more fun tasks.
#' and is optimized for user-friendliness. Advanced users can do most
#' things covered here, but they can do it faster with janitor and save
#' their thinking for more fun tasks.
#'
#' @docType package
#' @name janitor
#' @keywords internal
NULL
"_PACKAGE"
## quiets concerns of R CMD check re: the .'s that appear in pipelines
## and the "n" that is produced by dplyr::count() in a pipeline
if (getRversion() >= "2.15.1") utils::globalVariables(c(".", "n"))
53 changes: 53 additions & 0 deletions man/janitor-package.Rd

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

31 changes: 0 additions & 31 deletions man/janitor.Rd

This file was deleted.

0 comments on commit 81a2404

Please sign in to comment.