Merge pull request #267 from cmu-delphi/main

sync: main -> dev

CRAN-SUBMISSION

@@ -1,3 +1,3 @@
-Version: 1.1.0
-Date: 2024-02-27 20:25:04 UTC
-SHA: 693c04bd80d3ffe0b3c012281303c4878de08c70
+Version: 1.1.1
+Date: 2024-03-02 01:36:14 UTC
+SHA: 75ae42aed7a035d184af69129e049c31e76e5f3b

DEVELOPMENT.md

@@ -1,7 +1,7 @@
 ## Setting up the development environment
 
 ```r
-install.packages(c('devtools', 'pkgdown', 'styler', 'lintr')) # install dev dependencies
+pak::pkg_install(c('devtools', 'pkgdown', 'styler', 'lintr')) # install dev dependencies
 devtools::install_deps(dependencies = TRUE) # install package dependencies
 devtools::document() # generate package meta data and man files
 devtools::build() # build package
@@ -45,20 +45,36 @@ python -m http.server -d docs
 Please follow the guidelines in the [PR template document](.github/pull_request_template.md).
 
 ## Release process
-First, there's a handy function that makes a github issue; for example, at the time of writing we were doing:
-```R
-usethis::use_release_issue(version = "1.0.2")
-```
-If you want to extend it, add to the `release_bullets` function in [utils.R](https://github.com/cmu-delphi/epidatr/blob/dev/R/utils.R).
- First, make sure that all the checks pass
-
-```R
-devtools::check(".", manual = TRUE, env_vars =c(NOT_CRAN = "false"))
-```
 
-Aim for 10/10, no notes. Generally, follow the issue. `revdep_check` is likely to fail but doesn't seem to be terribly important. So for now ignore it.
-
-When this has gone smoothly enough, release to CRAN via
-```R
-devtools::release(check = TRUE)
-```
+Open a release issue and then copy and follow this checklist in the issue (modified from the checklist generated by `usethis::use_release_issue(version = "1.0.2")`):
+
+- [ ] `git pull`
+- [ ] Check [current CRAN check results](https://cran.rstudio.org/web/checks/check_results_epidatr.html)
+- [ ] `devtools::check(".", manual = TRUE, env_vars = c(NOT_CRAN = "false"))`.
+  - Aim for 10/10, no notes.
+- [ ] If check works well enough, merge to main. Otherwise open a PR to fix up.
+- [ ] [Polish NEWS](https://github.com/cmu-delphi/epidatr/blob/dev/NEWS.md).
+  - Some [guidelines](https://style.tidyverse.org/news.html#news-release).
+- [ ] `git checkout main`
+- [ ] `git pull`
+- [ ] `urlchecker::url_check()`.
+  - This may choke on the MIT license url, and that's ok.
+- [ ] `devtools::build_readme()`
+- [ ] `devtools::check_win_devel()`
+- [ ] Check email for problems
+- [ ] `revdepcheck::revdep_check(num_workers = 4)`.
+  - This may choke, it is very sensitive to the binary versions of packages on a given system. Either bypass or ask someone else to run it if you're concerned.
+- [ ] Update `cran-comments.md`
+- [ ] PR with any changes
+
+Submit to CRAN:
+
+- [ ] `devtools::submit_cran()`
+- [ ] Approve email
+
+Wait for CRAN...
+
+- [ ] Accepted :tada:
+- [ ] `dev`
+- [ ] `usethis::use_github_release(publish = FALSE)` (publish off, otherwise it won't push).
+- [ ] check the release notes and publish the branch on github

README.Rmd

@@ -79,6 +79,8 @@ pak::pkg_install("epidatr")
 pak::pkg_install("cmu-delphi/epidatr@dev")
 ```
 
+Our CRAN listing is [here](https://cran.r-project.org/web/packages/epidatr/index.html).
+
 ### API Keys
 
 The Delphi API requires a (free) API key for full functionality. To generate

README.md

@@ -81,6 +81,9 @@ pak::pkg_install("epidatr")
 pak::pkg_install("cmu-delphi/epidatr@dev")
 ```
 
+Our CRAN listing is
+[here](https://cran.r-project.org/web/packages/epidatr/index.html).
+
 ### API Keys
 
 The Delphi API requires a (free) API key for full functionality. To

cran-comments.md

@@ -1,4 +1,6 @@
+From 1.0.0 release:
 - Calls in the following files call an API which if queried too frequently without a key would result in CRAN being temporarily locked out of running API calls (so a soft-API key problem)
   - [`epidatr/R/epidatacall.R`]
   - [`epidatr/R/request.R`]
   - [`epidatr/R/endpoints.R`]
+