Changelog
Source:NEWS.md
plume 0.2.5
CRAN release: 2024-09-02
$get_author_list(suffix =)
is now slightly more flexible and will try less hard to sanitise author list suffixes (#90).PlumeQuarto
no longer converts roles to lower case (#88).PlumeQuarto
now supports authors’degrees
and thegroup
affiliation property (#53).PlumeQuarto
now properly handles authors with no roles (#81).PlumeQuarto
now supports.yml
and.yaml
files (#82).
plume 0.2.4
CRAN release: 2024-05-10
Tweaked some examples in the vignettes and expand the
Contributions
section invignette("plume")
.Fixed selection helpers not working when imported explicitly with
::
(#76).citation("plume")
now generates the complete and up-to-date citation of plume (#75).
plume 0.2.3
CRAN release: 2024-01-29
$new(initials_given_name = TRUE)
no longer makes initials if names are written in a script that doesn’t use letter cases (#73).Fixed
PlumeQuarto
’s example no longer working withwithr
3.0.0 due to a wrong usage oflocal_tempfile()
(#70).$get_author_list()
now throws a more informative error if corresponding authors have not been set (#69).The
.roles
parameter in$set_main_contributors()
now propagates roles that are not already set to any unnamed expression. This allows you to set the same main contributors across all but a few specific roles in a single call (#65).$to_yaml()
now only adds theaffiliations
schema if there is at least one affiliation (#67).$to_yaml()
now only adds authors’ id if there are at least two authors (#66).
plume 0.2.2
CRAN release: 2024-01-09
Documentation changes
-
vignette("working-in-other-languages")
has been extended to describe how to overwrite default arguments to match your preferred language better.
Minor improvements and bug fixes
Clarified error messages by suppressing purrr’s wrapper error (#63).
$to_yaml()
now writes author metadata in a separate YAML header if the original YAML header contains strippable meta-information such as comments, custom tags or folded blocks (#56, #61).The way
$set_*()
methods handle...
has been overhauled for more consistent results and to ensure the methods work correctly in edge cases (#59, #60).$get_contributions()
now throws the correct error if you pass a wrong argument to thesep
parameter (#55).The order of
$get_affiliations()
/$get_notes()
parameters have been switched for consistency purposes (#54).
plume 0.2.1
CRAN release: 2023-12-09
Fixed
$get_contributions()
wrongly reordering authors when using CRediT roles andby_author = TRUE
(#50).$get_contributions()
gains a new parametersep
that allows for finer control of how to separate contributors or roles (#49).$to_yaml()
now throws an error when invalid ORCID identifiers are found.Plume
’s parameterby
is now working properly (#48).The
format
parameter of$get_author_list()
is now deprecated in favour of the less ambiguous parametersuffix
(#47).
plume 0.2.0
CRAN release: 2023-11-30
New features
Plume
gains a new method$set_main_contributors()
that allows you to force one or more contributors to appear first in the contribution list for any given role. Because of this new method,Plume
’s contructor gained the parameterby
to set the defaultby
/.by
value used in all$set_*()
methods (#40).New helper
credit_roles()
that returns the 14 contributor roles of the Contributor Roles Taxonomy. These are now the default roles used by plume.
-
The plume role handling system has been overhauled for better flexibility and ease of use (#29).
-
plume classes gain a new parameter
roles
allowing you to specify roles using a named character vector.Rather than:
# A tibble: 2 × 4 given_name family_name role_1 role_2 <chr> <chr> <chr> <chr> 1 Zip Zap Supervision Writing 2 Ric Rac NA Writing
You can now use the following data structure:
# A tibble: 2 × 4 given_name family_name role_1 role_2 <chr> <chr> <dbl> <dbl> 1 Zip Zap 1 1 2 Ric Rac NA 1
And speficy roles when creating a
plume
object:Plume$new(data, roles = c(role_1 = "Supervision", role_2 = "Writing"))
plm_template()
gains a new parameterrole_cols
to create role columns from a character vector.
-
Lifecycle changes
$set_equal_contributor()
is now deprecated in favour of$set_cofirst_authors()
due to the ambiguous name of the method (#45).everyone_but()
is now deprecated as this function is not necessary since not more than a couple of authors should normally be given a particular status (#44).The
by
parameter in$set_*()
methods is now deprecated in favour of.by
for consistency purposes (#41).Defining roles explicitly in the input data or using
credit_roles = TRUE
are now deprecated in favour of defining role columns and roles via the parametersrole_cols
androles
, respectively (see details about the new role handling system above).
Minor improvements and bug fixes
Removed stringb dependency in favour of stringr (#42).
Updated the
encyclopedists
andencyclopedists_fr
data to comply with the new role column system (#39). Column names have also been homogenised (#46).$to_yaml()
now preserves line breaks preceding leading or isolated---
(#37).plm_template()
now returns role columns as numeric type (#26).Initials now drop dots present in author names (#31).
plume classes now error when a role column contains multiple roles (#28).