Skip to content

Commit 151e791

Browse files
committed
docs: first cran submission
1 parent 09df128 commit 151e791

File tree

8 files changed

+43
-37
lines changed

8 files changed

+43
-37
lines changed

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,4 @@
2020
^.venv$
2121
^env$
2222
^.env$
23+
^CRAN-SUBMISSION$

CRAN-SUBMISSION

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Version: 1.0.0
2+
Date: 2023-09-09 00:47:15 UTC
3+
SHA: 1d4c769015a2203b7abf7a2d1a6904fbd0c18064

R/cache.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ cache_info <- function() {
239239
#' The guts of caching, its interposed between fetch and the specific fetch
240240
#' methods. Internal method only.
241241
#'
242-
#' @param call the `epidata_call` object
242+
#' @param epidata_call the `epidata_call` object
243243
#' @param fetch_args the args list for fetch as generated by [`fetch_args_list()`]
244244
#' @keywords internal
245245
#' @importFrom openssl md5

R/covidcast.R

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
1+
#' turn a signal into a callable
2+
#' @param signal the signal of interest
3+
#' @param base_url the base url
14
parse_signal <- function(signal, base_url) {
25
class(signal) <- c("covidcast_data_signal", class(signal))
36
signal$key <- paste(signal$source, signal$signal, sep = ":")
47

58
#' fetch covidcast data
69
#'
7-
#' @param data_source data source to fetch
8-
#' @param signals data source to fetch
9-
#' @param geo_type geo_type to fetch
10-
#' @param time_type data source to fetch
11-
#' @param geo_values data source to fetch
12-
#' @param time_values data source to fetch
13-
#' @param as_of data source to fetch
14-
#' @param issues data source to fetch
15-
#' @param lag data source to fetch
16-
#' @return an instance of epidata_call
17-
#' @keywords internal
10+
#' param data_source data source to fetch
11+
#' param signals data source to fetch
12+
#' param geo_type geo_type to fetch
13+
#' param time_type data source to fetch
14+
#' param geo_values data source to fetch
15+
#' param time_values data source to fetch
16+
#' param as_of data source to fetch
17+
#' param issues data source to fetch
18+
#' param lag data source to fetch
19+
#' return an instance of epidata_call
20+
#' keywords internal
1821
signal$call <- function(geo_type,
1922
geo_values,
2023
time_values,

R/endpoints.R

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1106,7 +1106,9 @@ pub_fluview_meta <- function(fetch_args = fetch_args_list()) {
11061106
#' <https://github.com/cmu-delphi/delphi-epidata/blob/main/src/acquisition/fluview/fluview_locations.py>.
11071107
#'
11081108
#' @examples
1109-
#' pub_fluview(regions = "nat", epiweeks = epirange(201201, 202001))
1109+
#' \dontrun{
1110+
#' pub_fluview(regions = "nat", epiweeks = epirange(201201, 202005))
1111+
#' }
11101112
#' @param regions character. Locations to fetch. Can be any string IDs in
11111113
#' national, HHS region, census division, most states and territories, and so
11121114
#' on. Full list link below.

man/cache_epidata_call.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/parse_signal.Rd

Lines changed: 16 additions & 21 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/pub_fluview.Rd

Lines changed: 3 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)