From b1ef486af5746d0293d2f05b666c23538ac101dc Mon Sep 17 00:00:00 2001 From: olivroy Date: Thu, 18 Jan 2024 11:21:22 -0500 Subject: [PATCH] Add pkgdown function index --- R/janitor_deprecated.R | 1 + _pkgdown.yml | 60 +++++++++++++++++++++++++++++++++++++++ man/janitor_deprecated.Rd | 1 + 3 files changed, 62 insertions(+) diff --git a/R/janitor_deprecated.R b/R/janitor_deprecated.R index 2be26e7c..946a2924 100644 --- a/R/janitor_deprecated.R +++ b/R/janitor_deprecated.R @@ -12,6 +12,7 @@ #' * [remove_empty_cols()] -> [`remove_empty("cols")`][remove_empty()] #' #' @name janitor_deprecated +#' @keywords internal # EXCLUDE COVERAGE START NULL diff --git a/_pkgdown.yml b/_pkgdown.yml index fcbb6757..965f4647 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,3 +1,63 @@ url: https://sfirke.github.io/janitor/ template: bootstrap: 5 + + +reference: +- title: Cleaning data + +- subtitle: Cleaning variable names + contents: + - contains("clean_names") + +- title: Exploring data + desc: > + tabyls are an enhanced version of tables. See `vignette("tabyls")` + for more details. + contents: + - tabyl + - starts_with("adorn") + - contains("tabyl") + - -contains('.test') + +- subtitle: Change order + contents: + - row_to_names + - find_header + +- title: Comparison + desc: > + Compare data frames columns + contents: + - starts_with("compare_df_cols") + +- title: Removing unnecessary columns / rows + contents: + - starts_with("remove_") + - get_dupes + - get_one_to_one + - top_levels + - single_value + +- title: Rounding / dates helpers + desc: > + Help to mimic some behaviour from Excel or SAS. + These should be used on vector. + contents: + - round_half_up + - signif_half_up + - round_to_fraction + - excel_numeric_to_date + - sas_numeric_to_date + - excel_time_to_numeric + - starts_with("convert_to_date") + +- title: Misc / helpers + desc: > + These functions can help perform less frequent operations. + contents: + - describe_class + - paste_skip_na + - chisq.test + - fisher.test + - mu_to_u diff --git a/man/janitor_deprecated.Rd b/man/janitor_deprecated.Rd index 8c5c452c..6b9cb5c2 100644 --- a/man/janitor_deprecated.Rd +++ b/man/janitor_deprecated.Rd @@ -18,3 +18,4 @@ These functions have already become defunct or may be defunct as soon as the nex \item \code{\link[=remove_empty_cols]{remove_empty_cols()}} -> \code{\link[=remove_empty]{remove_empty("cols")}} } } +\keyword{internal}