Releases: FRBCesab/rcompendium
Releases · FRBCesab/rcompendium
rcompendium 1.4
New feature
add_github_actions_codemeta()creates acodemeta.jsonfile at the root of the project and adds a GH action to automatically update this file by GitHub servers.
Bug fixes
get_all_functions()better detects functions (e.g.function ())get_all_functions()ignoresjulia_library()functionsget_all_functions()screens Quarto filesadd_sticker()copies the sticker template infigures/readme/and no more inman/figures/(listed in the.gitignore)- Fix CRAN note about cross-references for external packages
Minor changes
- Remove dependency to
crayonandclisymbolsin favor ofcli - Improve templates
add_compendium()does not create subfolders indata/
rcompendium 1.3
-
Bug fixes
get_deps_*()better detects project dependencies and does not delete
packages called w/library("pkg")orlibrary('pkg')add_sticker()now copies the sticker template for compendium
-
Minor changes
- Provide instructions for installing V8 engine on Unix systems
rcompendium 1.2
-
New features
get_git_branch_name()detects git branch nameadd_contributing()adds aCONTRIBUTING.mdfile and issue templatesadd_code_of_conduct()adds aCODE_OF_CONDUCT.mdfileadd_github_actions_citation()adds a new GitHub action to update the
CITATION.cfffileadd_github_actions_document()adds a new GitHub action to updateRdfiles,
theNAMESPACEand theDESCRIPTIONfiles
-
Improvements
get_deps_*()better detects project dependenciesadd_compendium()allows now the user to choose its own compendium structure
-
Minor changes
- Update GitHub Actions templates (
yamlfiles) - Update README templates
- The
man/folder andNAMESPACEare now untracked by git (for compendium only) - Remove dependencies badge in README
- Change default values of
lifecycleandstatusarguments innew_package() - Change commit messages in
new_*()functions (conventional commits)
- Update GitHub Actions templates (
-
Deprecated
refresh()is now deprecated and will be deleted in the new version
rcompendium 1.1
- Update GitHub Actions templates (
yamlfiles) - Detect current git branch name in
add_readme_rmd() - Ignore
renvfiles (R build and GitHub) inadd_renv()
rcompendium 1.0
- New feature:
add_dockerfile()creates a basicDockerfilein compendium (new
argumentdokerfileinnew_compendium()) based onrocker/rstudio. - New feature:
add_renv()initializerenvenvironment in compendium (new
argumentrenvinnew_compendium()) - New feature:
add_github_actions_render()will automatically render
theREADME.mdon GitHub server after each push. This action is triggered
only if theREADME.Rmdhas been modified since the last commit. Also
add new argumentgh_renderinnew_*()functions. - New vignette: developing an R package
- New vignette: working with a compendium
- Function
add_dependencies()allows now missingR/folder and improves the
detection of dependencies in vignettes. - Function
add_lifecycle_badge()does not copy badge SVG in the project
anymore. The image badge is now created using https://shields.io/. - Update GHA templates. They are now derived from:
https://github.com/r-lib/actions/tree/v2-branch/examples - Rename default vignette title (title is now Get Started)
- Add
cph(copyright holder) tag inDESCRIPTIONfile - Change default package hexSticker and add R script in
inst/package-sticker/
to easily change the hexSticker - Rename commits messages (and remove emoji)
- For compendium: arguments
gh_checkandwebsiteare nowFALSEby default - For compendium: rename
rscripts/folder toanalyses/ - For compendium: delete
paper/folder - Review and improve documentation
- Rename templates file names
- Fix bug: detection of nested RStudio projects
rcompendium 0.5.1
First stable version.
Including modifications taking into account CRAN comments:
DESCRIPTIONfile: replace "The aim of the package 'rcompendium' is to make
easier..." by "Makes easier..."- Function
set_credentials()does not write the.Rprofilefile anymore
(not allowed by CRAN policies). Instead this function opens this file and users
need to manually paste the content of the clipboard. - Replace
utils::installed.packages()byfind.package()