update package examples and docs to make R CMD check happier

e-kotov · Dec 17, 2024 · 857c600 · 857c600
1 parent 662e973
commit 857c600
Show file tree

Hide file tree

Showing 11 changed files with 10 additions and 13 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,5 +1,5 @@
 Package: mapineqr
-Title: Access Mapineq inequality indicators via API
+Title: Access Mapineq Inequality Indicators via API
 Version: 0.0.0.9000
 Authors@R: 
     person("Egor", "Kotov", , "[email protected]", role = c("aut", "cre"),

diff --git a/R/data.R b/R/data.R
@@ -30,7 +30,7 @@
 #' @export
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' # Univariate example
 #' mi_data(
 #'   x_source = "TGS00010",

diff --git a/R/levels.R b/R/levels.R
@@ -5,9 +5,7 @@
 #' @export
 #' 
 #' @examples
-#' \dontrun{
 #' mi_nuts_levels()
-#' }
 #' 
 mi_nuts_levels <- function(){
   base_api_endpoint <- getOption("mapineqr.base_api_endpoint")

diff --git a/R/source-filters.R b/R/source-filters.R
@@ -14,7 +14,7 @@
 #' @export
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' mi_source_filters(
 #'   source_name = "DEMO_R_FIND2",
 #'   year = 2020,

diff --git a/R/sources.R b/R/sources.R
@@ -15,7 +15,7 @@
 #' 
 #' @examples
 #' 
-#' \dontrun{
+#' \donttest{
 #' # get up to 10 sources for NUTS level 3
 #' mi_sources("3", limit = 10)
 #' 
@@ -97,7 +97,7 @@ mi_sources <- function(
 #' @export
 #' 
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' mi_source_coverage("BD_HGNACE2_R3")
 #' 
 #' mi_source_coverage("ghs_smod")

diff --git a/man/mi_data.Rd b/man/mi_data.Rd
diff --git a/man/mi_nuts_levels.Rd b/man/mi_nuts_levels.Rd
diff --git a/man/mi_source_coverage.Rd b/man/mi_source_coverage.Rd
diff --git a/man/mi_source_filters.Rd b/man/mi_source_filters.Rd
diff --git a/man/mi_sources.Rd b/man/mi_sources.Rd
diff --git a/tools/meta-data-update-and-submission.R b/tools/meta-data-update-and-submission.R
@@ -6,6 +6,7 @@ codemetar::write_codemeta(write_minimeta = T)
 usethis::use_tidy_description()
 # urlchecker::url_check()
 # devtools::check(remote = TRUE, manual = TRUE)
+# devtools::check(cran = TRUE)
 # devtools::check_win_devel()
 # revdepcheck::revdep_check(num_workers = 4)