The use_git_hook argument of write_codemeta() has been deprecated. Solutions for keeping DESCRIPTION and codemeta.json in sync are available in the docs.
Docs were improved to make a better case for codemetar.
Changes in the way codeRepository is guessed. codemetar can now recognize an URL from GitHub, GitLab, Bitbucket, R-Forge among several URLs in DESCRIPTION, to assign it to codeRepository. If no URL in DESCRIPTION is from any of these providers,
guess_github() is called.
write_codemeta() indicating whether to also create the file schemaorg.json that corresponds to the metadata Google would validate, to be inserted to a webpage for SEO. It is saved as “schemaorg.json” alongside
path (by default, “codemeta.json”). This functionality requires the
jsonld package (listed under
Updated the GitHub action template to only run on pushes to the master branch and added an explanation of how that works to the readme. (@jonkeane)
Fix bug in crosswalking (#243)
Bug fix: the codeRepository is updated if there’s any URL in DESCRIPTION.
Bug fix: the README information is now updated by codemeta_readme(). Previously if e.g. a developmentStatus had been set previously, it was never updated.
Code cleaning following the book Martin, Robert C. Clean code: a handbook of agile software craftsmanship. Pearson Education, 2009. (@hsonne, #201, #202, #204, #205, #206, #207, #209, #210, #211, #212, #216, #218, #219, #220, #221).
Use of re-usable Rmd pieces for the README, intro vignette and man pages to reduce copy-pasting.
use_filesize = FALSEis now the default and the estimation of the file size does not leave any more unwanted files behind PR #239. Furthermore, the way the file size is calculated changed: Before we used the size of the package built with
pkgbuild::build(), which took rather long. Now the size is calculated based on the source files minus files excluded via
.Rbuildignore(if such a file exists).
write_codemeta(): the default of argument
FALSEto avoid an unwanted alteration of the user’s git environment issue #240.
write_codemeta()does not crash anymore if the
CITATIONfile contains a line
citation(auto = meta)Issue #238.
jsonld that is used only in
codemeta_validate() is now an optional dependency (Suggests rather than Imports).
The CodeRepository URL is now cleaned a bit (removing direct link to the README).
write_codemeta() gains a new argument
use_git_hook to make the creation of a DESCRIPTION/codemeta.json git pre-commit hook optional.
Encoding bug fixed in
extract_badges() now uses
xml2 instead of only regular expressions.
pkgbuild is now used directly instead of
give_opinion() now recognizes lifecycle badges, not only repostatus.org badges.
extract_badges for extracting information from all badges in a Markdown file.
give_opinion giving opiniated advice about package metadata
Changes to the create_codemeta output
relatedLink field now include provider URL and URL(s) from DESCRIPTION that are not the code repository
maintainer is now a list allowing for several maintainers since e.g. the BioConductor a4 package has two maintainers.
if more than one CI service among Travis, Appveyor and Circle CI are used and shown via a README badge they’re all added to the contIntegration field. URLs from codecov and coveralls badges are also added to the contIntegration field.
repo status inferred from the README now 1) is an URL instead of a word 2) recognizes either repostatus.org or Tidyverse lifecycle badges.
if present, priority is given to the Repository and BugReports fields of DESCRIPTION for filling the codeRepository and issueTracker fields of codemeta.json (which means working on a fork won’t change these).
ability to parse all CRAN-allowed MARC roles.
if there is a badge for an rOpenSci onboarding review and the review issue is closed, basic review metadata is added to codemeta.json
For dependencies, if the provider guessed is CRAN or BioConductor, their canonic CRAN/BioConductor URL is added to codemeta.json as sameAs, unless there’s a GitHub repo mentioned for them in Remotes in DESCRIPTION, in which case sameAs is that GitHub repo.
CRAN is now correctly translated as “Comprehensive R Archive Network”
If codeRepository is guessed to be a GitHub repo (via the URL field of DESCRIPTION or via git remote URL), the repo topics are queried via GitHub API V3 and added to the keywords (in combination with keywords stored in the X-schema.org-keywords field of DESCRIPTION)
SystemRequirements are now parsed using https://sysreqs.r-hub.io/, outputting URLs then stored in softwareRequirements
Help to remind to update codemeta.json regularly: Writing codemeta.json for the first time adds a git pre-commit hook and suggests adding a release question for devtools::release.
Now uses desc to parse DESCRIPTION files.
Package license changed to GPL because of code borrowed from usethis
Uses crul instead of httr and uses crul to check some URLs.
write_codemeta only uses Rbuildignore and a pre-commit git hook if the function is called from a package folder directly and with the path argument equal to “codemeta.json”
The calls to available.packages() for guess_provider now happen inside memoised functions.