Prep for CRAN

ropensci · Jun 4, 2022 · ad01efd · ad01efd
1 parent 12297d2
commit ad01efd
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 27 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -38,8 +38,7 @@ Imports:
     sjlabelled,
     stringr,
     tibble,
-    tidyr,
-    xml2
+    tidyr
 Suggests:
     covr,
     knitr,
@@ -52,4 +51,4 @@ VignetteBuilder:
 Encoding: UTF-8
 LazyData: FALSE
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.2
+RoxygenNote: 7.2.0
diff --git a/R/fetch_survey.R b/R/fetch_survey.R
@@ -43,7 +43,7 @@
 #' used. Defaults to `FALSE`.
 #' @param time_zone String. A local timezone to determine response date
 #' values. Defaults to `NULL` which corresponds to UTC time. See
-#' ["Dates and Times"](https://api.qualtrics.com/instructions/) from Qualtrics
+#' ["Dates and Times"](https://api.qualtrics.com/) from Qualtrics
 #' for more information on format.
 #' @param breakout_sets Logical. If `TRUE`, then the
 #' [qualtRics::fetch_survey()] function will split multiple

diff --git a/R/read_survey.R b/R/read_survey.R
@@ -12,7 +12,7 @@
 #' to `TRUE`.
 #' @param time_zone String. A local timezone to determine response date
 #' values. Defaults to `NULL` which corresponds to UTC time. See
-#' ["Dates and Times"](https://api.qualtrics.com/instructions/) from Qualtrics
+#' ["Dates and Times"](https://api.qualtrics.com/) from Qualtrics
 #' for more information on format.
 #' @param legacy Logical. If `TRUE`, then import "legacy" format CSV files
 #' (as of 2017). Defaults to `FALSE`.

diff --git a/README.Rmd b/README.Rmd
@@ -72,7 +72,7 @@ Note that you can only export surveys that you own, or to which you have been gi
 
 ## Register your Qualtrics credentials
 
-There are two important credentials you need to authenticate with the Qualtrics API. These are your **API key** and **datacenter-specific base URL**. The base URL you pass to the qualtRics package should look like `yourdatacenterid.qualtrics.com`, without a scheme such as `https://`. The [Qualtrics API documentation](https://api.qualtrics.com/instructions/) explains how you can find your base URL.
+There are two important credentials you need to authenticate with the Qualtrics API. These are your **API key** and **datacenter-specific base URL**. The base URL you pass to the qualtRics package should look like `yourdatacenterid.qualtrics.com`, without a scheme such as `https://`. The [Qualtrics API documentation](https://api.qualtrics.com/) explains how you can find your base URL.
 
 You can store your API credentials `QUALTRICS_API_KEY` and `QUALTRICS_BASE_URL` in your `.Renviron` file for repeated use across sessions. The qualtRics package has a function to help with this.
 

diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Ginn](https://jasperhg90.github.io/)<br/> **License:**
 <!-- badges: start -->
 
 [![R-CMD-check](https://github.com/ropensci/qualtRics/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/qualtRics/actions)
-[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/qualtRics)](https://cran.r-project.org/package=qualtRics)
+[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/qualtRics)](https://cran.r-project.org/package=qualtRics)
 [![Codecov test
 coverage](https://codecov.io/gh/ropensci/qualtRics/branch/master/graph/badge.svg)](https://app.codecov.io/gh/ropensci/qualtRics?branch=master)
 [![rOpenSci](https://badges.ropensci.org/192_status.svg)](https://github.com/ropensci/software-review/issues/192)
@@ -68,8 +68,8 @@ Currently, the package contains three core functions:
 
 1.  `all_surveys()` fetches a list of all surveys that you own or have
     access to from Qualtrics.
-2.  `fetch_survey()` downloads a survey from Qualtrics and loads it
-    into R.
+2.  `fetch_survey()` downloads a survey from Qualtrics and loads it into
+    R.
 3.  `read_survey()` allows you to read CSV files you download manually
     from Qualtrics.
 
@@ -94,9 +94,8 @@ There are two important credentials you need to authenticate with the
 Qualtrics API. These are your **API key** and **datacenter-specific base
 URL**. The base URL you pass to the qualtRics package should look like
 `yourdatacenterid.qualtrics.com`, without a scheme such as `https://`.
-The [Qualtrics API
-documentation](https://api.qualtrics.com/instructions/) explains how you
-can find your base URL.
+The [Qualtrics API documentation](https://api.qualtrics.com/) explains
+how you can find your base URL.
 
 You can store your API credentials `QUALTRICS_API_KEY` and
 `QUALTRICS_BASE_URL` in your `.Renviron` file for repeated use across
@@ -154,4 +153,4 @@ Feedback, bug reports (and fixes!), and feature requests are welcome;
 file issues or seek support
 [here](https://github.com/ropensci/qualtRics/issues).
 
-[![ropensci\_footer](https://ropensci.org/public_images/ropensci_footer.png)](https://ropensci.org)
+[![ropensci_footer](https://ropensci.org/public_images/ropensci_footer.png)](https://ropensci.org)
diff --git a/cran-comments.md b/cran-comments.md
@@ -1,14 +1,6 @@
 ## Release summary
 
-This is the 12th CRAN release of qualtRics (the 6th since it has returned to CRAN since being archived). This release improves user messaging and internal functions, and adds functionality for survey description data (`fetch_description()`) and finding survey IDs (`fetch_id()`).
-
-## Test environments
-
-* local macOS install: release
-* macOS 10.15.7 (on GitHub actions): release
-* windows server 2019 10.0.17763 (on GitHub actions): release
-* ubuntu 20.04 (on GitHub actions): release, devel
-* win-builder: release, devel
+This is the 13th CRAN release of qualtRics (the 7th since it has returned to CRAN after being archived). This release improves error handling when making API calls, as well as updating and adding more handling of distribution data. One update reflects a change in the Qualtrics API.
 
 ## R CMD check results
 

diff --git a/man/fetch_survey.Rd b/man/fetch_survey.Rd
diff --git a/man/read_survey.Rd b/man/read_survey.Rd
diff --git a/vignettes/qualtRics.Rmd b/vignettes/qualtRics.Rmd
@@ -18,7 +18,7 @@ comment = "#>"
 
 [Qualtrics](https://www.qualtrics.com/) is an online survey and data collection software platform. Qualtrics is used across many domains in both academia and industry for online surveys and research. While users can manually download survey responses from Qualtrics through a browser, importing this data into R is then cumbersome. The qualtRics R package implements the retrieval of survey data using the Qualtrics API and aims to reduce the pre-processing steps needed in analyzing such surveys. 
 
-Note that your institution must support API access and that it must be enabled for your account. Whoever manages your Qualtrics account can help you with this. Please refer to the [Qualtrics documentation](https://api.qualtrics.com/instructions/) to find your API token.
+Note that your institution must support API access and that it must be enabled for your account. Whoever manages your Qualtrics account can help you with this. Please refer to the [Qualtrics documentation](https://api.qualtrics.com/) to find your API token.
 
 The authors and contributors for this R package are not affiliated with Qualtrics and Qualtrics does not offer support for this R package.
 
@@ -40,7 +40,7 @@ Note that you can only export surveys that you own, or to which you have been gi
 
 ## Registering your Qualtrics credentials
 
-There are two important credentials you need to authenticate with the Qualtrics API. These are your **API key** and **datacenter-specific base URL**. The base URL you pass to the qualtRics package should look like `yourdatacenterid.qualtrics.com`, without a scheme such as `https://`. The [Qualtrics API documentation](https://api.qualtrics.com/instructions/) explains how you can find your base URL.
+There are two important credentials you need to authenticate with the Qualtrics API. These are your **API key** and **datacenter-specific base URL**. The base URL you pass to the qualtRics package should look like `yourdatacenterid.qualtrics.com`, without a scheme such as `https://`. The [Qualtrics API documentation](https://api.qualtrics.com/) explains how you can find your base URL.
 
 You can store your API credentials `QUALTRICS_API_KEY` and `QUALTRICS_BASE_URL` in your `.Renviron` file for repeated use across sessions. The qualtRics package has a function to help with this.
 
@@ -88,7 +88,7 @@ mysurvey <- fetch_survey(surveys$id[4],
 ```
 
 
-Note that your date and time settings may not correspond to your own timezone. You can find out how to do this [here](https://www.qualtrics.com/support/survey-platform/managing-your-account/research-core-account-settings/#user-settings). See ["Dates and Times"](https://api.qualtrics.com/instructions/) for more information about how Qualtrics handles dates and times. **Keep in mind that this is important if you plan on using times / dates as cut-off points to filter data**.
+Note that your date and time settings may not correspond to your own timezone. You can find out how to do this [here](https://www.qualtrics.com/support/survey-platform/managing-your-account/research-core-account-settings/#user-settings). See ["Dates and Times" under "Instructions"](https://api.qualtrics.com/) for more information about how Qualtrics handles dates and times. **Keep in mind that this is important if you plan on using times / dates as cut-off points to filter data**.
 
 You may also reference a response ID; `fetch_survey()` will then download all responses that were submitted after that response: