plume (version 0.3.0)

StatusSetterPlume: StatusSetterPlume class

Description

Internal class extending StatusSetter for Plume.

Super classes

plume::NameHandler -> plume::PlumeHandler -> plume::StatusSetter -> StatusSetterPlume

Methods

Public methods

• StatusSetterPlume$set_main_contributors()

• StatusSetterPlume$clone()

Inherited methods

• plume::PlumeHandler$data()
• plume::PlumeHandler$get_plume()
• plume::PlumeHandler$get_roles()
• plume::PlumeHandler$print()
• plume::PlumeHandler$roles()
• plume::StatusSetter$initialize()
• plume::StatusSetter$set_corresponding_authors()

---

Method set_main_contributors()

Force one or more contributors' names to appear first in the contribution list.

Usage

StatusSetterPlume$set_main_contributors(..., .roles = NULL, .by = NULL)

Arguments

...

One or more unquoted expressions separated by commas. Expressions matching values in the column defined by by or .by determine main contributors. Expressions can be named after any role to set different main contributors to different roles at once, in which case the .roles parameter only applies roles that are not already set to unnamed expressions. Matching of values is case-insensitive and dot- agnostic.

.roles

Roles to assign main contributors to. If .roles is a named vector, only the names will be used.

.by

Variable used to specify which authors are main contributors. By default, uses authors' id.

Returns

The class instance.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

StatusSetterPlume$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.