Skip to content

plume 0.2.0

Compare
Choose a tag to compare
@arnaudgallou arnaudgallou released this 30 Nov 11:36

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 regained the parameter by to set the default by/.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 parameter role_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 parameters role_cols and roles, respectively (see details about the new role handling system above).

Documentation changes

  • The using-credit-roles vignette was removed as it is no longer needed.

Minor improvements and bug fixes

  • Removed stringb dependency in favour of stringr (#42).

  • Updated the encyclopedists and encyclopedists_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).