update package docs for v0.1.4 (#110)

* update package docs for verbose flag * add ORCID (#111) --------- Co-authored-by: Andrew Martin <almartin82@users.noreply.github.com>
UrbanInstitute · Jun 22, 2023 · eb88cd0 · eb88cd0
1 parent 3aad05d
commit eb88cd0
Show file tree

Hide file tree

Showing 18 changed files with 138 additions and 118 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,13 +1,14 @@
 Package: educationdata
 Type: Package
 Title: Retrieve Records from the Urban Institute's Education Data Portal API  
-Version: 0.1.3
+Version: 0.1.4
 Authors@R: c(
     person("Erika", "Tyagi", email = "etyagi@urban.org", role = "cre"), 
     person("Kyle", "Ueyama", email = "khueyama@gmail.com", role = "aut"),
+    person("Andrew", "Martin", email = "almartin@gmail.com", role="ctb", comment = c(ORCID = "0009-0005-5117-323X")),
     person(given = "The Urban Institute", role = c("cph"))
     )
-Date: 2022-09-29
+Date: 2023-06-21
 URL: https://urbaninstitute.github.io/education-data-package-r/
 BugReports: https://github.com/UrbanInstitute/education-data-package-r/issues
 Description: Allows R users to retrieve and parse data from the Urban 

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,6 @@
+## educationdata 0.1.4 (2023-06-21)
+* Added `verbose` argument to `get_education_data()` to optionally avoid printing messages and warnings, kudos @almartin82 for the contribution.
+
 ## educationdata 0.1.3 (2022-09-29)
 * Updated test suite to to comply with the following CRAN policy: 
     > Packages which use Internet resources should fail gracefully with an informative message if the resource is not available or has changed (and not give a check warning nor error).

diff --git a/R/get_education_data.R b/R/get_education_data.R
@@ -8,7 +8,7 @@
 #' @param filters Optional 'list' of query values to filter an API call
 #' @param add_labels Add variable labels (when applicable)? Defaults to FALSE.
 #' @param csv Download the full csv file? Defaults to FALSE.
-#' @param verbose Print messages and warnings?  Defaults to TRUE
+#' @param verbose Print messages and warnings? Defaults to TRUE.
 #'
 #' @return A `data.frame` of education data
 #'

diff --git a/README.Rmd b/README.Rmd
@@ -73,6 +73,7 @@ where:
 call.
 * add_labels - Add variable labels (when applicable)? Defaults to `FALSE`.
 * csv - Download the full csv file? Defaults to `FALSE`.
+* verbose - Print messages and warnings? Defaults to `TRUE`.
 
 ## Available Endpoints
 

diff --git a/README.md b/README.md
@@ -80,6 +80,7 @@ where:
 - add_labels - Add variable labels (when applicable)? Defaults to
   `FALSE`.
 - csv - Download the full csv file? Defaults to `FALSE`.
+- verbose - Print messages and warnings? Defaults to `TRUE`.
 
 ## Available Endpoints
 

diff --git a/docs/404.html b/docs/404.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