cffr 1.0.1

• Update cff_write() to add a new encoding argument to make it work with
  different encodings, see iconv().
• Fix NOTEs due to empty lines in docs.

Full Changelog: v1.0.1...v1.0.1

cffr 1.0.0

This is a major release with some notable changes. The change mainly affects to non-core functions, hence the natural workflow (cff_create() → cff_write() → cff_validate()) shouldn't be affected.

Major changes

Classes and methods

Now cffr implements a new class system for definitions.reference, definitions.person and definitions.entity objects:

• List of definitions.reference (e.g, references) has class cff_ref_lst, cff and individual elements (e.g preferred-citation or each
  member of references) has class cff_ref, cff.
• List of definitions.person or definitions.entity (e.g. authors, contact) has class cff_pers_lst, cff and individual elements (e.g publisher or each member of authors) has class cff_pers, cff.

This change allow to write specific S3
Methods and extend the capabilities of the
package.

• New as_cff() S3 generic method (replacing as.cff()): This method coerces
  R objects to cff class format. Current methods provided are:
  • as_cff.Bibtex().
  • as_cff.bibentry(), replacing cff_parse_citation().
  • as_cff.person(), similar to as_cff_person() but only for person objects. We recommend using as_cff_person() since it can coerce also string representing authors in BibTeX markup ("{von Neumen}, James"), that can't be captured properly via methods.
• New as_bibentry() method for a variety of classes (character, list,
  NULL and classes defined by cffr).
• New as_cff_person() method.
• The following base and utils methods supports now 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 reviewed to provide more clarity on functions naming and to facilitate internal maintenance. This change only affects to non-core functions. Now each function does less things but does it better. The old API has been deprecated and it would warn when used, providing advice on the replacement function.

Deprecation

• cff_to_bibtex() and cff_extract_to_bibtex(): replaced by as_bibentry()
  S3 generic.
• cff_parse_person() and cff_parse_person_bibtex(): replaced by
  as_cff_person() S3 generic.
• cff_parse_citation(): replaced by 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

• Now reading from external files is performed exclusively by cff_read() (that is designed to fit all supported file types on a single entry point) and the new specific readers (that are used under the hood by cff_read()), namely:
  • cff_read_cff_citation(),
  • cff_read_description(),
  • cff_read_citation()
  • cff_read_bib().
• New cff_modify() function for updating and modifying cff objects easily.

Other changes

• Minimum R version required now is 4.0.0.
• Update of BibTeX crosswalk (see vignette("bibtex_cff", package = "cffr")) and consequently changes in the mapping performed by as_bibtex()
cff_parse_citation():
  • @inBook and @book gains a new value on [CFF]{.underline} when
    series is provided: [collection-type: book-series.]{.underline}
  • Can handle BibLaTeX @inBook, that differs significantly from BibTeX
    @inBook.

What's Changed

• Update lint.yaml by @dieghernan in #57
• Bump actions/checkout from 3 to 4 by @dependabot in #59
• Bump github/codeql-action from 2 to 3 by @dependabot in #60
• Bump actions/upload-artifact from 3 to 4 by @dependabot in #61
• Overhaul of cff-bibtex conversion system by @dieghernan in #63
• New API by @dieghernan in #65
• Refactor internal code by @dieghernan in #67
• Doc review by @dieghernan in #68

New Contributors

• @dependabot made their first contribution in #59

Full Changelog: v0.5.0...v1.0.0

cffr 0.5.0

Lifecycle

• Function cff_to_bibtex() and cff_extract_to_bibtex() have been merged,
  the latter (cff_extract_to_bibtex()) is now soft-deprecated.

New features

• New function write_citation() that can generate a inst/CITATION file from
  a cff object (#51).

Enhancements

• Additional authors of a R package can be now included based on the role
  on the DESCRIPTION file, via the parameter authors_roles (#49).

• New message interface based on cli
  capabilities.

• Now the (invisible) result of cff_validate() 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

• Improvements in the extraction of `date-release`.

What's Changed

• Allow to add more authors by role by @dieghernan in #50
• Improve testing by @dieghernan in #52
• Improve documentation by @dieghernan in #53
• Improve tests and messages by @dieghernan in #54
• Add write_citation function by @dieghernan in #55

Full Changelog: v0.4.1...v0.5.0

cffr 0.4.1

• Replace crayon dependency for cli (#46).
• Improvements on the performance of cff_validate().

What's Changed

• Update badge by @dieghernan in #45
• Migrate to cli from crayon by @dieghernan in #47

Full Changelog: v0.4.0...v0.4.1

cffr 0.4.0

• Fix typo (#40) by @dpprdan
• Add new function cff_from_bibtex().
• Consistent behavior on dependency urls when RSPM is the default repo (i.e. on GitHub Actions or RStudio Cloud).

What's Changed

• typo by @dpprdan in #40
• Add cff_from_bibtex() by @dieghernan in #41

New Contributors

• @dpprdan made their first contribution in #40

Full Changelog: v0.3.0...v0.4.0

cffr 0.3.0

• preferred-citation is only produced when a CITATION (R) file has been
  provided with the package (#37).
• Improve email handling on authors.
• Add cff_read() function. This functionality was already implemented on
  cff() but new function added in order to provide clarity.

What's Changed

• Improve preferred-citation handling by @dieghernan in #38

Full Changelog: v0.2.3...v0.3.0

cffr 0.2.3

• Update docs to HTML5

Full Changelog: v0.2.2...v0.2.3

cffr 0.2.2

• cffr now uses a local copy of the schema.json for validating. (#33).

What's Changed

• Validate against a local copy by @dieghernan in #34

Full Changelog: v0.2.1...v0.2.2

cffr 0.2.1

• GitHub Action now runs only on master or mainbranch.

• Better handling of references

Full Changelog: v0.2.0...v0.2.1

cffr 0.2.0

• Now cffr extracts also information of the package dependencies and adds
  the main citation of the dependencies to the references field, using
  citation(auto = TRUE).

  • New dependencies parameter on cff_create() and cff_write().

• Other improvements on cff_parse_citation():

  • cff_parse_citation() extracts more information of authors, based on
    the fields provided on the DESCRIPTION file.

  • cff_parse_citation() does a better job extracting information from
    bibentry() /BibTeX and mapping it to preferred-citation/references
    fields of CFF.

• Add new functions for working with git pre-commit hooks
  :

  • cff_git_hook_install()
  • cff_git_hook_remove()

• New BibTeX functions:

  • cff_extract_to_bibtex()
  • cff_to_bibtex()
  • cff_parse_person_bibtex()
  • write_bib()

• Add a new dependency: lifecycle.

What's Changed

• Rebase hook by @dieghernan in #23
• Add a git hook by @dieghernan in #24
• Add capacities for creating bibtex files by @dieghernan in #26
• Improve bibtex conversion by @dieghernan in #27
• New vignette by @dieghernan in #28

Full Changelog: v0.1.1...v0.2.0