Internal code and documentation were reviewed and refactored with AI
assistance to improve maintainability, consistency and user-facing
messages.
Tests were improved with AI assistance to reduce dependence on
external services and make internal fixtures more robust.
cffr 1.4.0
DOIs in inst/CITATIONurl fields are
detected, including those matching the pattern
.*dx.doi.org/.
The website field in definitions.person
and definitions.entity uses ROR as a fallback.
cff_read() correctly handles a single
languages value (#105).
cff_validate() now uses the ajv validation engine
through jsonvalidate::json_validate(), which returns more
informative error messages.
cffr 1.3.0
The minimum required R version is now
4.1.0.
Vignettes were migrated to Quarto.
cffr 1.2.1
as_cff_person() improves comment detection and parsing
across its function family.
cff_gha_update() now runs in ubuntu-latest
by default to save GitHub
Actions quota (#90, thanks to @Pakillo).
The mapping of CRAN packages to SPDX codes was
updated.
cffr 1.2.0
cff_write() gains a new r_citation
argument. When it is set to TRUE, an R
citation file (inst/CITATION) is generated or updated with
the information from the generated CITATION.cff file.
No backup copy is created. For more control, use
cff_write_citation() (#79).
repository-code now also recognizes Codeberg as a valid repository
(#88).
repository-code recognizes repositories regardless of
casing. Lowercase is still recommended as a good practice for
R developers.
If the package has a CITATION file providing a DOI, the
CITATION DOI is used as the main CITATION.cffdoi and the CRAN DOI is added as an
identifier.
Otherwise, the CRAN DOI is used as
doi.
When extracting dependencies
(e.g. cff_create(dependencies = TRUE)) and the package
dependency is on CRAN, the CRAN DOI is
used for the dependency in the references key.
commit is extracted from RemoteSha.
The cran_to_spdx dataset was updated.
cffr 1.0.1
cff_write() gains a new encoding argument
to make it work with different encodings. See iconv().
Fixed NOTEs caused by empty lines in docs.
cffr 1.0.0
This is a major release with some notable changes. The main change
affects non-core functions. The natural workflow
(cff_create() → cff_write() →
cff_validate()) should not be affected.
A list of definitions.reference objects
(e.g. references) has class cff_ref_lst, cff
and individual elements (e.g. preferred-citation or each
member of references) have class
cff_ref, cff.
A list of definitions.person or
definitions.entity objects (e.g. authors,
contact) has class cff_pers_lst, cff and
individual elements (e.g. publisher or each member of
authors) have class cff_pers, cff.
This change allows writing specific S3 methods and extends the
capabilities of the package.
as_cff() is a new S3 generic method that replaces
as.cff() and coerces R objects to
cff class format. Current methods provided are:
as_cff.person(), similar to
as_cff_person() but only for person objects.
We recommend using as_cff_person() since it can also coerce
strings representing authors in BibTeX markup
("{von Neumen}, James"), which cannot be captured properly
through methods.
as_bibentry() is a new method for a variety of classes
(character, list, NULL and
classes defined by cffr).
as_cff_person() is a new method.
The following base and utils
package methods now support the cff class:
as.data.frame.cff().
as.person(), although only for
definitions.person or definitions.entity
(e.g. authors, contacts, editors,
publisher, etc.).
head.cff(), tail.cff().
toBibtex.cff().
API
The API has been completely revised to provide more clarity on
function naming and to facilitate internal maintenance. This change
onlyaffects non-core functions. Each
function now does fewer things but does them better. The old API has
been deprecated and now warns when used, providing advice on the
replacement function.
Deprecation
cff_to_bibtex() and
cff_extract_to_bibtex(): replaced by the
as_bibentry() S3 generic.
cff_parse_person() and
cff_parse_person_bibtex(): replaced by the
as_cff_person() S3 generic.
cff_parse_citation(): replaced by the
as_cff() S3 generic.
cff_from_bibtex(): replaced by
cff_read_bib() (for *.bib files) and
cff_read_bib_text() (for character strings).
write_bib() and write_citation(): replaced
by cff_write_bib() and cff_write_citation(),
respectively.
Argument path in cff() is also deprecated,
use cff_read() instead.
New capabilities
cff_read() now handles reading from external files
exclusively. It is designed to fit all supported file types in a single
entry point, along with new specific readers used under the hood by
cff_read():
cff_read_cff_citation().
cff_read_description().
cff_read_citation().
cff_read_bib().
cff_modify() is a new function for updating and
modifying cff objects easily.
Other changes
The minimum required R version is now
4.0.0.
The BibTeX crosswalk was updated (see
vignette("bibtex-cff", package = "cffr")), with
corresponding changes in the mapping performed by
as_bibtex() and cff_parse_citation():
@inbook and @book gain a new value
in CFF when series is provided:
collection-type: book-series.
cffr can now handle BibLaTeX
@inbook, which differs significantly from BibTeX
@inbook.
cffr 0.5.0
Lifecycle
cff_to_bibtex() and
cff_extract_to_bibtex() have been merged.
cff_extract_to_bibtex() is now soft-deprecated.
New features
write_citation() is a new function that can generate an
inst/CITATION file from a cff object
(#51).
Enhancements
Additional authors of an R package can now be
included based on roles in the DESCRIPTION file, through
the authors_roles argument (#49).
The invisible result of cff_validate() now includes
the summary of errors (if any) as an attributes() named
"error", as jsonvalidate::json_validate() does
when verbose = TRUE:
Be verbose? If TRUE, then an attribute
"errors" will list validation failures as a data frame.
Improved extraction of date-released.
cffr 0.4.1
Replaced the crayon dependency with
cli (#46).
cff_validate() performance was improved.
cffr 0.4.0
Fixed typo (#40, thanks to @dpprdan).
Added cff_from_bibtex().
Dependency URLs now behave consistently when RSPM is the default
repository (for example, on GitHub Actions or RStudio Cloud).
cffr 0.3.0
preferred-citation is only produced when
inst/CITATION has been provided with the package
(#37).
Improved email handling for authors.
Added cff_read(). This functionality was already
implemented in cff(), but the new function provides
clarity.
cffr 0.2.3
Fixed the HTML5 issue as requested by CRAN.
cffr 0.2.2
cffr now uses a local copy of
schema.json for validation (#33).
cffr 0.2.1
The GitHub Actions workflow now runs only on the master
or main branch.
References are handled better.
cffr 0.2.0
cffr now also extracts information about package
dependencies and adds the main citation of the dependencies to the
references key, using citation(auto = TRUE).
Added the dependencies argument to
cff_create() and cff_write().
Other improvements to cff_parse_citation() include:
cff_parse_citation() extracts more information about
authors, based on the fields provided in the DESCRIPTION
file.
cff_parse_citation() does a better job extracting
information from bibentry()/BibTeX and mapping it to the
preferred-citation and references CFF
keys.
Added new functions for working with git pre-commit hooks :
cff_git_hook_install().
cff_git_hook_remove().
Added new BibTeX functions:
cff_extract_to_bibtex().
cff_to_bibtex().
cff_parse_person_bibtex().
write_bib().
Added a new dependency: lifecycle.
cffr 0.1.1
Accepted by JOSS.
Added pages to cff_parse_citation().
Added the gh_keywords argument to
cff_create()/cff_write(). If
TRUE, it includes GitHub repository topics as
keywords.
:
