provide basic source info for can_prov_cases

Author: nmdefries

R/epipredict-data.R

@@ -81,8 +81,22 @@
 #' Copyright Johns Hopkins University 2020.
 "counts_subset"
 
-#' COVID Cases for Canada 
+#' Canadian COVID-19 case rates
 #'
-#' THIS IS A STUB This dataset covers the period from March 2020 to March 2023 and is
-#' used in the [epipredict] slide vignette.
+#' Data set for all Canadian provinces and territories containing COVID-19
+#' case rates (COVID-19 cases per 100,000 people) derived from COVID-19 case
+#' counts as reported by the
+#' \href{https://opencovid.ca/}{COVID-19 Canada Open Data Working Group (CCODWG)}.
+#' Data is available throught the associated ccodwg/Covid19Canada GitHub
+#' repository.
+#'
+#' This dataset contains versioned data covering the period from April 2020 to
+#' December 2021 and is used in the [epipredict] slide vignette.
+#'
+#' @source This object contains a modified part of the COVID-19 Canada Open
+#' Data Working Group's
+#' \href{https://github.com/ccodwg/Covid19Canada}{Covid19Canada data repository}.
+#' This data set is licensed under the terms of the
+#' \href{https://creativecommons.org/licenses/by/4.0/}{Creative Commons Attribution 4.0 International license}
+#' by the COVID-19 Canada Open Data Working Group.
 "can_prov_cases"

data-raw/can_prov_cases.R

@@ -31,6 +31,7 @@ if (gh_token == "") {
 
 ## Get list of new and modified files to download
 # The `path` field filters commits to only those that modifying the listed dir
+# From https://www.github.com/ccodwg/Covid19Canada
 BASE_URL <- "https://api.github.com/repos/ccodwg/Covid19Canada/commits?sha=%s&per_page=%s&path=timeseries_prov/cases_timeseries_prov.csv&until=%s&page=%s"
 ITEMS_PER_PAGE <- 100
 BRANCH <- "master"