Adding new R packages
This has been automated with the
g6tr_package_setup()
function. But please recheck all the points manually.
- Create a new package inside the packages directory. Package folder should contain:
R,tests,vignettes,data(optional),inst(optional),pkgdownfoldersDESCRIPTION,NEWS.md,.Rbuildignorefiles.Rprofilefile. This should be the same as for all other packages.pkgdown/_pkgdown.ymlfile where functions and vignettes will be listed- Nice to have:
README.mdand a HexSticker insideman/figures
-
Create an S3 folder for this package in docs.gradientmetrics.com
- It needs to have at least
register.html,signing.htmlandjs/files copied from another package - use
_instead of a.in the folder name
- It needs to have at least
-
Adjust the main pkgdown.yaml to include the new package.
-
Extend GitHub Action builds executing
R CMD CHECKfor the new package- Copy Ubuntu workflow from the template workflow and put it to .github/workflows
- Adjust names so that they reflect the new package (like
g6tr.reports) - Adjust Linux dependency installation and R dependency installation steps in workflow with more specific instructions if needed; although sometimes the template code may be just enough
- Extend main monorepo’s
README.mdwith a new build checks/icons