final final final?

medewitt · Feb 28, 2019 · a8b8180 · a8b8180
1 parent 928bfdc
commit a8b8180
Show file tree

Hide file tree

Showing 31 changed files with 162 additions and 70 deletions.
diff --git a/R/add_qwi_labels.R b/R/add_qwi_labels.R
@@ -5,8 +5,14 @@
 #'
 #' @examples \donttest{
 #'library(tidyqwi)
+#'
+#' # Add labels
 #'labelled_nc <- add_qwi_labels(nc_qwi)
 #'
+#' # Check the label for the data
+#'attr(labelled_nc[["Emp"]], "label")
+#'
+#'
 #'}
 #'
 #'@export

diff --git a/R/check_census_api_call.R b/R/check_census_api_call.R
@@ -2,7 +2,18 @@
 #' @param call a returned call from the US Census API
 #' @import xml2
 #' @import  httr
+#'@examples \donttest{
+#'library(tidyqwi)
+#'library(httr)
+#' # A single call to the API without an API Key
+#'url <- "api.census.gov/data/timeseries/qwi/sa?get=Emp&for=county:198&key=NOKEY"
+#'single_call <- httr::GET(url)
 #'
+#'# Because a non valid API key was specified an message will be returned
+#'
+#'check_census_api_call(single_call)
+#'
+#'}
 #'
 #' @export
 

diff --git a/R/check_fips.R b/R/check_fips.R
@@ -5,10 +5,10 @@
 #' @examples \donttest{
 #' library(tidyqwi)
 #'
-#' convert_fips(37)
-#' convert_fips("37")
-#' convert_fips("NC")
-#' convert_fips("nc")
+#' converted_fips(37)
+#' converted_fips("37")
+#' converted_fips("NC")
+#' converted_fips("nc")
 #'
 #' }
 #'

diff --git a/R/get_qwi.R b/R/get_qwi.R
@@ -24,15 +24,15 @@
 #'@import utils
 #'@importFrom future plan
 #'
-#'@examples \donttest{
+#'@examples \dontrun{
 #'library(tidyqwi)
 #'
 #' # One state, one year
 #'nc_qwi <- get_qwi(years = "2010",
 #'                states = "11",
 #'                geography = "county",
 #'                apikey =  census_key,
-#'                quiet = TRUE, endpoint = "rh",
+#'                endpoint = "rh",
 #'                variables = c("sEmp", "Emp"), all_groups = FALSE,
 #'                industry_level = "2", processing = "sequential")
 #'
@@ -41,7 +41,7 @@
 #'                states = c("NC", "SC"),
 #'                geography = "county",
 #'                apikey =  census_key,
-#'                quiet = TRUE, endpoint = "rh",
+#'                endpoint = "rh",
 #'                variables = c("sEmp", "Emp"), all_groups = FALSE,
 #'                industry_level = "2", processing = "sequential")
 #'}

diff --git a/R/parse_qwi_message.R b/R/parse_qwi_message.R
@@ -1,4 +1,5 @@
 #'@title parse_qwi
+#'@description An internally used function to parse the returned API call.
 #'@param x a returned call response from the US Census QWI API
 #'@export
 

diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/articles/multi_state_year.html b/docs/articles/multi_state_year.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/reference/add_qwi_labels.html b/docs/reference/add_qwi_labels.html
diff --git a/docs/reference/check_census_api_call.html b/docs/reference/check_census_api_call.html
diff --git a/docs/reference/converted_fips.html b/docs/reference/converted_fips.html