Release epidemics 0.3.0

[pratikunterwegs]

This issue is a checklist for a v0.3.0 GH release as the endpoint of this project for vector inputs to the Ebola model. Some CRAN-related items have been removed and additional items have been copied from #149.

• [x] Update (aspirational) install instructions in README
• [x] Proofread Title: and Description:
• [x] Check that all exported functions have @return and @examples
• [x] Check that Authors@R: includes a copyright holder (role 'cph')
• [x] Check licensing of included files
• [x] Review https://github.com/DavisVaughan/extrachecks

Prepare for release:

• [ ] git pull
• [x] urlchecker::url_check()
• [ ] devtools::build_readme()
• [ ] devtools::check(remote = TRUE, manual = TRUE)
• [ ] devtools::check_win_devel()
• [ ] git push
• [ ] Run goodpractice::gp()
• [x] Review WORDLIST
• [x] Check if # nolint comments are still needed with recent lintr releases

Post release

• [ ] usethis::use_github_release()
• [ ] usethis::use_dev_version(push = TRUE)

Supercharge your pkgdown website

• [x] Verify that website URL is listed in _pkgdown.yml
• [x] Verify pkgdown site is using epiversetheme
• [x] Add logo to epiverse-trace/hex-stickers
• [x] Use svg version of logo
• [x] Verify logo is properly detected by pkgdown & r-universe (path and name need to be exactly man/figures/logo.png or man/figures/logo.svg)
• [x] Add a pkgdown reference index: https://pkgdown.r-lib.org/reference/build_reference.html#reference-index. Use selectors (e.g., starts_with() or contains()) to select functions rather than an explicit list. This serves the double purpose of checking that functions follow a coherent naming scheme.
• [x] Verify intro vignette appears under 'Get started'
• [x] Verify vignettes are ordered correctly (if applicable)
• [ ] Verify all images include helpful alt-text

Developer tools

• [x] Update lintr, roxygen, usethis, testthat, devtools to the latest version on your local computer: pak::pak(c("lintr", "devtools"), dependencies = TRUE)
• Copy from packagetemplate:
  • [x] .lintr config file
  • [x] GitHub Actions worfklows
  • [x] tools/ folder
  • [x] tests/spelling.R
  • [x] tests/testthat/helper-state.R
  • [x] tests/testthat/setup-options.R
• [x] Run spelling::spell_check_package()

Misc good practice

• [x] Change files ending in .r to .R in R/ and/or tests/testthat/"
• [x] Review usage of # nolint comments. New versions of lintr may have squashed previous bugs
• [x] Update year in license file

Documentation

• [x] Use roxygen2 markdown syntax (usethis::use_roxygen_md())
• [x] Add a related project section at the end of the README
• [x] Check that all URLs are working, up-to-date, and leading directly to the expected page: urlchecker::url_check()
• [x] Add package-level documentation page: usethis::use_package_doc()
• [x] Move package-level imports to the package-level documentation
• [x] Verify that all @import and @importFrom import functions that are actually used in the relevant function
• [x] Identify potential for reuse in documentation
• [x] Run devtools::document()

DESCRIPTION

• [x] Verify if any package in Remotes is still necessary
• [x] Check that package Description is still in line with the current scope
• [x] Make sure links to GitHub repository and issue tracker are listed: usethis::use_github_links()
• [x] Re-order and standardize DESCRIPTION with desc::desc_normalize()

Final R CMD check

• [x] Run devtools::check() locally to catch NOTEs and WARNINGs that can still easily slip through continuous integration

GitHub

• [ ] Check if issues are still relevant. If not, please close them, ideally with a link to the commit fixing them or a comment explaining why they no longer apply.
• [ ] Check if discussions you started are still ongoing. If not, please close the thread.

[pratikunterwegs]

Closed as fixed by #217.