Releases: FRBCesab/rcompendium
Releases · FRBCesab/rcompendium
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.md
file and issue templatesadd_code_of_conduct()
adds aCODE_OF_CONDUCT.md
fileadd_github_actions_citation()
adds a new GitHub action to update the
CITATION.cff
fileadd_github_actions_document()
adds a new GitHub action to updateRd
files,
theNAMESPACE
and theDESCRIPTION
files
-
Improvements
get_deps_*()
better detects project dependenciesadd_compendium()
allows now the user to choose its own compendium structure
-
Minor changes
- Update GitHub Actions templates (
yaml
files) - Update README templates
- The
man/
folder andNAMESPACE
are now untracked by git (for compendium only) - Remove dependencies badge in README
- Change default values of
lifecycle
andstatus
arguments 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 (
yaml
files) - Detect current git branch name in
add_readme_rmd()
- Ignore
renv
files (R build and GitHub) inadd_renv()
rcompendium 1.0
- New feature:
add_dockerfile()
creates a basicDockerfile
in compendium (new
argumentdokerfile
innew_compendium()
) based onrocker/rstudio
. - New feature:
add_renv()
initializerenv
environment in compendium (new
argumentrenv
innew_compendium()
) - New feature:
add_github_actions_render()
will automatically render
theREADME.md
on GitHub server after each push. This action is triggered
only if theREADME.Rmd
has been modified since the last commit. Also
add new argumentgh_render
innew_*()
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 inDESCRIPTION
file - 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_check
andwebsite
are nowFALSE
by 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:
DESCRIPTION
file: replace "The aim of the package 'rcompendium' is to make
easier..." by "Makes easier..."- Function
set_credentials()
does not write the.Rprofile
file 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()