Internals docs

R/check.R

@@ -1,5 +1,6 @@
 #' Allows character vectors
 #' @importFrom checkmate assert_character assert_integerish
+#' @keywords internal
 assert_character_param <- function(name, value, len = NULL, required = TRUE) {
   null.ok <- !required
   assert_integerish(len, null.ok = TRUE, .var.name = "len")
@@ -8,6 +9,7 @@ assert_character_param <- function(name, value, len = NULL, required = TRUE) {
 
 #' Allows integer-like vectors
 #' @importFrom checkmate assert_integerish
+#' @keywords internal
 assert_integerish_param <- function(name, value, len = NULL, required = TRUE) {
   null.ok <- !required
   assert_integerish(len, null.ok = TRUE, .var.name = "len")
@@ -16,6 +18,7 @@ assert_integerish_param <- function(name, value, len = NULL, required = TRUE) {
 
 #' Allows a vector of date_like params: date, character, or integer-like
 #' @importFrom checkmate check_date check_character check_integerish
+#' @keywords internal
 assert_date_param <- function(name, value, len = NULL, required = TRUE) {
   null.ok <- !required
   assert_integerish(len, null.ok = TRUE, .var.name = "len")

R/epidatacall.R

@@ -128,7 +128,7 @@ fetch <- function(epidata_call, fields = NULL, disable_date_parsing = FALSE) {
 }
 
 #' Fetches the data and returns a tibble
-#' @rdname epidata_call
+#' @rdname fetch_tbl
 #'
 #' @param epidata_call an instance of `epidata_call`
 #' @param fields a list of epidata fields to return, or NULL to return all
@@ -142,7 +142,7 @@ fetch <- function(epidata_call, fields = NULL, disable_date_parsing = FALSE) {
 #' @return
 #' - For `fetch_tbl`: a [`tibble::tibble`]
 #' @importFrom tibble as_tibble
-#'
+#' @keywords internal
 fetch_tbl <- function(epidata_call, fields = NULL, disable_date_parsing = FALSE) {
   stopifnot(inherits(epidata_call, "epidata_call"))
   stopifnot(is.null(fields) || is.character(fields))
@@ -162,7 +162,7 @@ fetch_tbl <- function(epidata_call, fields = NULL, disable_date_parsing = FALSE)
 #' Fetches the data, raises on epidata errors, and returns the results as a
 #' JSON-like list
 #'
-#' @rdname epidata_call
+#' @rdname fetch_classic
 #'
 #' @param epidata_call an instance of `epidata_call`
 #' @param fields a list of epidata fields to return, or NULL to return all
@@ -176,7 +176,7 @@ fetch_tbl <- function(epidata_call, fields = NULL, disable_date_parsing = FALSE)
 #' @importFrom jsonlite fromJSON
 #' @return
 #' - For `fetch_classic`: a JSON-like list
-#'
+#' @keywords internal
 fetch_classic <- function(epidata_call, fields = NULL, disable_data_frame_parsing = TRUE) {
   stopifnot(inherits(epidata_call, "epidata_call"))
   stopifnot(is.null(fields) || is.character(fields))
@@ -224,7 +224,7 @@ full_url <- function(epidata_call) {
 }
 
 #' Returns the full request url for the given epidata_call
-#' @rdname epidata_call
+#' @rdname request_url
 #'
 #' @param epidata_call an instance of `epidata_call`
 #' @param format_type format to return one of classic,json,csv
@@ -235,6 +235,7 @@ full_url <- function(epidata_call) {
 #' @importFrom httr modify_url
 #' @return
 #' - For `request_url`: string containing the URL
+#' @keywords internal
 request_url <- function(epidata_call, format_type = "classic", fields = NULL) {
   stopifnot(inherits(epidata_call, "epidata_call"))
   url <- full_url(epidata_call)

R/utils.R

@@ -1,6 +1,6 @@
 #' Helper function to cast values, non-list vectors, and/or EpiRanges to strings
 #'
-#' @noRd
+#' @keywords internal
 format_item <- function(value) {
   if (inherits(value, "EpiRange")) {
     paste0(toString(value$from), "-", toString(value$to))
@@ -13,7 +13,7 @@ format_item <- function(value) {
 
 #' Helper function to build a list of values and/or ranges
 #'
-#' @noRd
+#' @keywords internal
 format_list <- function(values) {
   paste(vapply(values, format_item, character(1L)), collapse = ",")
 }