replace dontrun with donttest for examples that hit the statcan web server and drop dontrun from the two examples that don't make any web request.

Author: mountainMath

R/cansim.R

@@ -12,7 +12,7 @@
 #' @return tibble format data table output
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' # Retrieve a table with an NDM code
 #' get_cansim("34-10-0013")
 #' # Retrieve a table with an old-style CANSIM code
@@ -51,7 +51,7 @@ adjust_cansim_values_by_variable <-function(data, var){
 #' @return Returns the input tibble with with adjusted values
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' cansim_table <- get_cansim("34-10-0013")
 #' normalize_cansim_values(cansim_table)
 #' }
@@ -138,7 +138,7 @@ normalize_cansim_values <- function(data, replacement_value=NA, normalize_percen
 #' @return new-format NDM table number
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' cansim_old_to_new("026-0018")
 #' }
 #' @export
@@ -307,7 +307,7 @@ parse_and_fold_in_metadata <- function(data,meta,data_path){
 #' @return tibble format data table output
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim("34-10-0013")
 #' }
 #' @export
@@ -379,7 +379,7 @@ get_cansim_ndm <- function(cansimTableNumber, language="english", refresh=FALSE,
 #  Set to higher values for large tables and slow network connection. (Default is \code{200}).
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_table_info("34-10-0013")
 #' }
 #' @export
@@ -403,7 +403,7 @@ get_cansim_table_info <- function(cansimTableNumber, language="english", refresh
 #  Set to higher values for large tables and slow network connection. (Default is \code{200}).
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_table_survey("34-10-0013")
 #' }
 #' @export
@@ -426,7 +426,7 @@ get_cansim_table_survey <- function(cansimTableNumber, language="english", refre
 #  Set to higher values for large tables and slow network connection. (Default is \code{200}).
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_table_subject("34-10-0013")
 #' }
 #' @export
@@ -449,7 +449,7 @@ get_cansim_table_subject <- function(cansimTableNumber, language="english", refr
 #  Set to higher values for large tables and slow network connection. (Default is \code{200}).
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_table_short_notes("34-10-0013")
 #' }
 #' @export
@@ -472,7 +472,7 @@ get_cansim_table_short_notes <- function(cansimTableNumber, language="english",
 #  Set to higher values for large tables and slow network connection. (Default is \code{200}).
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_column_list("34-10-0013")
 #' }
 #' @export
@@ -496,7 +496,7 @@ get_cansim_column_list <- function(cansimTableNumber, language="english", refres
 #  Set to higher values for large tables and slow network connection. (Default is \code{200}).
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_column_categories("34-10-0013", "Geography")
 #' }
 #' @export
@@ -523,7 +523,7 @@ get_cansim_column_categories <- function(cansimTableNumber, column, language="en
 #' @return none
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_table_overview("34-10-0013")
 #' }
 #' @export
@@ -568,7 +568,7 @@ get_cansim_table_overview <- function(cansimTableNumber, language="english", ref
 #' @return A vector of categories
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' data <- get_cansim("16-10-0117")
 #' categories_for_level(data,"North American Industry Classification System (NAICS)",level=2)
 #' }
@@ -662,7 +662,7 @@ generate_table_metadata <- function(){
 #' @return none
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' view_cansim_webpage("34-10-0013")
 #' }
 #' @export
@@ -682,7 +682,7 @@ view_cansim_webpage <- function(cansimTableNumber){
 #' @return a tibble containing the table metadata
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_cube_metadata("34-10-0013")
 #' }
 #' @export
@@ -733,7 +733,7 @@ get_cansim_cube_metadata <- function(cansimTableNumber){
 #' @return String object containing URL for specified table number
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_table_url("34-10-0013")
 #' get_cansim_table_url("34-10-0013", language = "fr")
 #' }
@@ -757,7 +757,7 @@ get_cansim_table_url <- function(cansimTableNumber, language = "en"){
 #' @return A tibble with Statistics Canada data table product ids and their release times
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_changed_tables("2018-08-01")
 #' }
 #' @export
@@ -786,7 +786,7 @@ get_cansim_changed_tables <- function(start_date){
 #  Set to higher values for large tables and slow network connection. (Default is \code{200}).
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_table_notes("34-10-0013")
 #' }
 #' @export

R/cansim_helpers.R

@@ -177,7 +177,7 @@ short_prov.fr <- purrr::set_names(c(
 #' @return a code{cansim} package data frame with additional factor GEO.abb that contains language-specific provincial abbreviations
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' df <- get_cansim("17-10-0005")
 #' df <- add_provincial_abbreviations(df)
 #' }
@@ -206,7 +206,7 @@ add_provincial_abbreviations <- function(data){
 #' @return a tibble with english and french labels for the given code set
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_code_set("survey")
 #' }
 get_cansim_code_set <- function(code_set=c("scalar", "frequency", "symbol", "status", "uom", "survey",  "subject", "wdsResponseStatus"),

R/cansim_tables_list.R

@@ -102,9 +102,9 @@ get_cansim_table_list_page <- function(start_offset=0,max_rows=1000){
 #' @return A tibble with available Statistics Canada data tables, listing title, Statistics Canada data table catalogue number, deprecated CANSIM table number, description, and geography
 #'
 #' @examples
-#' \dontrun{
+#'
 #' list_cansim_tables()
-#' }
+#'
 #' @export
 list_cansim_tables <- function(refresh=FALSE){
   # flow: if cansim.cache_path version exists, use that, otherwise fall back on package version
@@ -152,9 +152,9 @@ list_cansim_tables <- function(refresh=FALSE){
 #' @return A tibble with available Statistics Canada data tables, listing title, Statistics Canada data table catalogue number, deprecated CANSIM table number, description and geography that match the search term.
 #'
 #' @examples
-#' \dontrun{
+#'
 #' search_cansim_tables("Labour force")
-#' }
+#'
 #' @export
 search_cansim_tables <- function(search_term, search_fields = "both", refresh=FALSE){
   tables <- list_cansim_tables(refresh = refresh)
@@ -183,7 +183,7 @@ search_cansim_tables <- function(search_term, search_fields = "both", refresh=FA
 #' start and end dates, achieve status, subject and survey codes, frequency codes and a list of cube dimensions.
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' list_cansim_cubes()
 #' }
 #'
@@ -262,7 +262,7 @@ list_cansim_cubes <- function(lite=FALSE,refresh=FALSE){
 #' @return A tibble with available Statistics Canada data cubes, listing title, Statistics Canada data cube catalogue number, deprecated CANSIM table number, survey and subject.
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' search_cansim_cubes("Labour force")
 #' }
 #'

R/cansim_vectors.R

@@ -77,7 +77,7 @@ rename_vectors <- function(data,vectors){
 #' @return A tibble with data for vectors released between start and end time
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_vector("v41690973","2015-01-01")
 #' }
 #' @export
@@ -126,7 +126,7 @@ get_cansim_vector<-function(vectors, start_time, end_time=Sys.time(), use_ref_da
 #' @return A tibble with data for specified vector(s) for the last N periods
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_vector_for_latest_periods("v41690973",10)
 #' }
 #' @export
@@ -172,7 +172,7 @@ get_cansim_vector_for_latest_periods<-function(vectors, periods=1){
 #' @return A tibble with data matching specified coordinate and period input arguments
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_data_for_table_coord_periods("35-10-0003",coordinate="1.12.0.0.0.0.0.0.0.0",periods=3)
 #' }
 #' @export
@@ -207,7 +207,7 @@ get_cansim_data_for_table_coord_periods<-function(cansimTableNumber, coordinate,
 #' @return A tibble with metadata for selected vectors
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' get_cansim_vector_info("v41690973")
 #' }
 #' @export