added .og vignette file, created .rda for running examples, templates…

… folder for documentation
getwilds · Mar 20, 2024 · a90aca4 · a90aca4
1 parent 88ab933
commit a90aca4
Show file tree

Hide file tree

Showing 8 changed files with 469 additions and 25 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -24,3 +24,5 @@ Suggests:
     testthat
 Config/testthat/edition: 3
 VignetteBuilder: knitr
+Depends: 
+    R (>= 2.10)
diff --git a/R/process-resp.R b/R/process-resp.R
@@ -20,9 +20,8 @@
 #' @noRd
 #'
 #' @examples
-#' \dontrun{
-#' process_resp(resp, demographics)
-#' }
+#' process_resp(resp, "demographics")
+#' 
 process_resp <- function(resp, topic) {
   if (httr2::resp_content_type(resp) != "text/csv") {
     cli_abort("Invalid input, please check documentation for valid arguments.")

diff --git a/R/risk-alcohol.R b/R/risk-alcohol.R
@@ -13,10 +13,8 @@
 #' - `"American Indian / Alaska Native (non-Hispanic)"`
 #' - `"Asian / Pacific Islander (non-Hispanic)"`
 #' - `"Hispanic (Any Race)"`.
-#' @param sex One of the following values:
-#' - `"both sexes"`
-#' - `"male"`
-#' - `"female"`.
+#' 
+#' @template sex
 #'
 #' @importFrom httr2 req_url_query req_perform
 #' @importFrom stats setNames

diff --git a/R/sysdata.rda b/R/sysdata.rda
diff --git a/man-roxygen/sex.R b/man-roxygen/sex.R
@@ -0,0 +1,4 @@
+#' @param sex One of the following values:
+#' - `"both sexes"`
+#' - `"male"`
+#' - `"female"`.