- Add README.Rmd
- Update
DESCRIPTION
and use description data inREADME.Rmd
- Add ORCID
- Update my ORCID details
- Write a utility function to sort
.Rbuildignore
- Implement pkgdown
- Add links / update Rd formatting for all function documentation.
- Add dummy imports to silence R CMD check note per tidyverse
- Migrate
build_analysis_site()
to rdev - Switch from development version of
styler
(1.3.2.9000) when a new release becomes available -
Validate thatlint_all
works as expected withinci
- Add 'create package' workflow example to README, remove TODO section "Analysis package creation process"
- Move
_pkgdown.yml
to repository root to make projects discoverable by the pgkdown GitHub query - Update
README.Rmd
template to dynamically generate list of notebooks inanalysis
- Automate release process
- Automate creation of feature branches, including 'Bump version' using
desc::desc_bump_version("dev")
- Add check to
stage_release()
to look for missing topics in_pkgdown.yml
reference section - Update
use_rdev_package()
- Handle
.Rmd
files that already have anhtml_document
section - Move
rmd_metadata()
from README-analysis.Rmd to rdev package - Add tests per comments in
R/
after reading package book, documentation - Update Roxygen comments after reading package book, documentation, review and merge duplicate Roxygen docs
- Write a manual regression test script (notes with R commands)
as a vignetteto validate 'Creating Packages'and 'GitHub Releases' - Add messages, warnings to
build_analysis_site()
to report on progress - Add function to spell check notebooks
- Automate branch protection
- Address issue r-lib/usethis#1568, which has been closed
- Add dplyr when running
use_analysis_package()
-
Consider switchingper the R macOS FAQ, "Only the CRAN build is guaranteed to be compatible with the package binaries on CRAN (or Bioconductor)."getOption("pkgType")
fromsource
toboth
per R options - Support creating repos in organizations
-
Consider incorporating the GitHub description intoDESCRIPTION
- Create a wrapper for
spelling
that includes notebooks in package spell checking, WORDLIST - Add a
spell_check_test_notebooks()
function for CI spellchecks on notebooks - Convert manual tests (
Setup.Rmd
) into an R Script that can be run from within the package created withcreate_github_repo()
- Add a function to add missing (notebook) dependencies to DESCRIPTION, see
renv::dependencies()
anddesc::desc_get_deps()
- Add
check_renv()
toci()
and stop ifrenv::status()
is not up to date - Replace proof-docs with urlchecker, support checking GitHub Pages
docs
directory usingurl_db_from_HTML_files
(ask if a PR for this would be accepted) - Move scripts from
tools
toinst/bin
or similar, per Stack Overflow and R Packages - Switch from development versions of
styler
(1.3.2.9000) andlintr
(2.0.1.9000) when a new release becomes available - both were needed to address bugs in the current release versions, 1.3.2 and 2.0.1. - Add trailing slash to GitHub Pages URL
- Update
lint_all()
to lint all types, including.Rpres
-
Add custom CSS files to(issue exists in unsupported Safari 14 but not Safari 15)_site.yml
and analysis notebook templates to control font size, as described in this article, or possibly usingbs_theme()
, since pkgdown customizes the default usingbuild_bslib()
-
Removepkgdown/extra.css
if r-lib/pkgdown#2377 is accepted -
Establish default knitr options, includingknitr::opts_chunk$set(fig.align = "center")
, add to analysis template, also review settings for Advanced R -
Consider using RStudio Extensions: - Move
shift-heading-level-by: 1
from_quarto.yml
toanalysis/_metadata.yml
, soTODO.md
renders properly - Remove
preset: bootstrap
workaround when pkgdown 2.0.8+ is released (per r-lib/pkgdown#2376) - Replace
dev = TRUE
logic if rstudio/renv#1695 is accepted - Update errors and messages after reading Advanced R Conditions and re-reading the Tidyverse Style Guide
- Reduce the number of Imports, per R CMD check:
> devtools::check()
...
> checking package dependencies ... NOTE
Imports includes 30 non-default packages.
Importing from so many packages makes the package vulnerable to any of
them becoming unavailable. Move as many as possible to Suggests and
use conditionally.
- Set up GitHub Actions
- Faster CI checks
-
Switch to fullR CMD check
? - Update GitHub Actions from r-lib examples
- Run test coverage
-
Skip CI checks for changes in only thedocs/
directory -
Add GitHub Action for html/link checking using something like htmlproofer -
Autobuilddocs/
like pkgdown ?