diff --git a/R/clean_anzsco.R b/R/clean_anzsco.R index 01e4394..b576b68 100644 --- a/R/clean_anzsco.R +++ b/R/clean_anzsco.R @@ -1,6 +1,6 @@ -#' Convert ANZSCO names and abbreviations into the consistent format used by the Australian Bureau of Statistics. -#' This function enables both exact (default) and fuzzy matching. -#' Under exact matching, if no match is found, NA is returned. +#' @title Convert ANZSCO names and abbreviations into the consistent format used by the Australian Bureau of Statistics. +#' +#' @description This function enables both exact (default) and fuzzy matching. Under exact matching, if no match is found, NA is returned. #' #' @param x a (character) vector containing ANZSCO titles. #' Note that \code{clean_anzsco} always returns a character vector. If no match is found, then \code{NA} is returned. diff --git a/R/clean_anzsic.R b/R/clean_anzsic.R index 7198f61..0e17bcf 100644 --- a/R/clean_anzsic.R +++ b/R/clean_anzsic.R @@ -1,6 +1,6 @@ -#' Convert ANZSIC names and abbreviations into the consistent format used by the Australian Bureau of Statistics. -#' This function enables both exact (default) and fuzzy matching. -#' Under exact matching, if no match is found, NA is returned. +#' @title Convert ANZSIC names and abbreviations into the consistent format used by the Australian Bureau of Statistics. +#' +#' @description This function enables both exact (default) and fuzzy matching. Under exact matching, if no match is found, NA is returned. #' #' @param x a (character) vector containing ANZSIC titles. #' Note that clean_anzsic always returns a character vector. If no match is found, then NA is returned. diff --git a/R/clean_helpers.R b/R/clean_helpers.R index 847d885..fa97391 100644 --- a/R/clean_helpers.R +++ b/R/clean_helpers.R @@ -1,4 +1,4 @@ -#' clean_titles is a helper function for the clean +#' clean_titles is a helper function for the cleaning of titles #' #' @param dictionary a dictionary created with the make_dictionary function #' @param .vector a character vector diff --git a/R/is_holiday.R b/R/is_holiday.R index 1088b35..01ad1a8 100644 --- a/R/is_holiday.R +++ b/R/is_holiday.R @@ -1,5 +1,4 @@ -#' @title is_holiday -#' @description Identifies if a given date is a public holiday in Australia +#' @title Identifies if a given date is a public holiday in Australia #' @param date Date, POSIXct object or a string that can be parsed with `parsedate::parse_date` #' @param jurisdictions Vector of state jurisdictions you wish to filter on, defaults to all of Australia #' @return logical(`TRUE` or `FALSE`) vector diff --git a/_pkgdown.yml b/_pkgdown.yml index 7ea7798..3d6e7c0 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -32,9 +32,18 @@ reference: contents: - starts_with("anz") - starts_with("asced") + - auholidays - title: "Importing ABS Data" desc: > Functions for retrieving ABS data contents: - get_seifa - get_seifa_index_sheet + - title: "Helper functions" + desc: > + Functions for cleaning data and working with datasets + in the package + contents: + - is_holiday + - starts_with("clean_") + - starts_with("make_") diff --git a/man/clean_anzsco.Rd b/man/clean_anzsco.Rd index 28860c0..742c789 100644 --- a/man/clean_anzsco.Rd +++ b/man/clean_anzsco.Rd @@ -2,9 +2,7 @@ % Please edit documentation in R/clean_anzsco.R \name{clean_anzsco} \alias{clean_anzsco} -\title{Convert ANZSCO names and abbreviations into the consistent format used by the Australian Bureau of Statistics. -This function enables both exact (default) and fuzzy matching. -Under exact matching, if no match is found, NA is returned.} +\title{Convert ANZSCO names and abbreviations into the consistent format used by the Australian Bureau of Statistics.} \usage{ clean_anzsco( x, @@ -35,9 +33,7 @@ Only relevant when fuzzy_match is TRUE.} a character vector of cleaned values that have matches in the official format. } \description{ -Convert ANZSCO names and abbreviations into the consistent format used by the Australian Bureau of Statistics. -This function enables both exact (default) and fuzzy matching. -Under exact matching, if no match is found, NA is returned. +This function enables both exact (default) and fuzzy matching. Under exact matching, if no match is found, NA is returned. } \examples{ diff --git a/man/clean_anzsic.Rd b/man/clean_anzsic.Rd index 0ae7eb6..77727c4 100644 --- a/man/clean_anzsic.Rd +++ b/man/clean_anzsic.Rd @@ -2,9 +2,7 @@ % Please edit documentation in R/clean_anzsic.R \name{clean_anzsic} \alias{clean_anzsic} -\title{Convert ANZSIC names and abbreviations into the consistent format used by the Australian Bureau of Statistics. -This function enables both exact (default) and fuzzy matching. -Under exact matching, if no match is found, NA is returned.} +\title{Convert ANZSIC names and abbreviations into the consistent format used by the Australian Bureau of Statistics.} \usage{ clean_anzsic( x, @@ -35,9 +33,7 @@ Only relevant when fuzzy_match is TRUE.} a character vector } \description{ -Convert ANZSIC names and abbreviations into the consistent format used by the Australian Bureau of Statistics. -This function enables both exact (default) and fuzzy matching. -Under exact matching, if no match is found, NA is returned. +This function enables both exact (default) and fuzzy matching. Under exact matching, if no match is found, NA is returned. } \examples{ diff --git a/man/clean_titles.Rd b/man/clean_titles.Rd index aa3642b..d1704e1 100644 --- a/man/clean_titles.Rd +++ b/man/clean_titles.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/clean_helpers.R \name{clean_titles} \alias{clean_titles} -\title{clean_titles is a helper function for the clean} +\title{clean_titles is a helper function for the cleaning of titles} \usage{ clean_titles( dictionary = NULL, @@ -35,5 +35,5 @@ Only relevant when fuzzy_match is TRUE.} a character vector of cleaned values that have matches in the dictionary. } \description{ -clean_titles is a helper function for the clean +clean_titles is a helper function for the cleaning of titles } diff --git a/man/is_holiday.Rd b/man/is_holiday.Rd index 8cc84f6..635c22d 100644 --- a/man/is_holiday.Rd +++ b/man/is_holiday.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/is_holiday.R \name{is_holiday} \alias{is_holiday} -\title{is_holiday} +\title{Identifies if a given date is a public holiday in Australia} \usage{ is_holiday(date, jurisdictions = c()) }