Merge pull request runapp-aus#40 from bryceroney/update-pkgdown-strayr

Update documentation as a consequence of merging in strayr

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.

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.

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

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

_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_")