plume 0.3.0

New features

• New new_plume() and new_plume_quarto() that are aliases for Plume$new() and PlumeQuarto$new(), respectively (#124).

• New plm_symbols() to set the symbols used in Plume (#119).

• Plume$new() and PlumeQuarto$new() gain a new parameter dotted_initials to control whether or not initials should be dotted. This parameter replaces the dotted_initials parameter of $get_contributions(), which is now deprecated (#112).

• Plume$new() gains a new parameter distinct_initials to differentiate similar authors' initials, when possible. This is done by adding extra letters from the last word of authors' family name until initials are unique. Initials will remain in the short form if authors share the same family name (#111).

• New as_lines() to output vector elements on distinct lines when rendering an R Markdown or Quarto document (#98).

Breaking changes

• Setting new default names to a plume subclass must now be done via the names field (#117).

Minor improvements and bug fixes

• $get_author_list() now correctly drops leading ^ when there are no symbols to display (#127).

• ORCID icons are now ignored in Quarto documents due to a change introduced in Quarto 1.5 regarding how paths are resolved. They continue to work in R Markdown as before (#109).

• Plume now automatically escapes special Markdown characters used as symbols (#119).

• $set_*() methods are now dot-agnostic (#113).

• The orcid variable is now customisable (#96).

Lifecycle changes

• All functionalities deprecated in 0.2.1 and earlier now throw an error. This includes:

  • The credit_roles parameter in plm_template() and $new().

  • The format parameter in $get_author_list().

  • The by parameter in $set_*() methods.

  • everyone_but().

  • $set_equal_contributor().

  • Defining authors' roles explicitly in the input dataset.

Newly deprecated

• $get_plume() is deprecated in favour of $data() (#115).

• $get_roles() is deprecated in favour of $roles() (#114).

• The dotted_initials parameter of $get_contributions() is now deprecated. This parameter must now be set in the constructors (#112).

• orcid() is deprecated in favour of icn_orcid() (#105).

• The format parameter of $get_contact_details() is now deprecated in favour of the more explicit template parameter (#104).