ProjectMember: ProjectMember class representing a CorrelAid Project Member

In CorrelAid/projectutils: "Small Utility Functions Managing CorrelAid Projects"

ProjectMember class representing a CorrelAid Project Member

Description

ProjectMember class representing a CorrelAid Project Member

ProjectMember class representing a CorrelAid Project Member

Active bindings

project_id

character. id of the project in the form YYYY-mm-ABB.

volunteer_id

character. id of the volunteer.

team_id

character. id of the team. Defaults to 1.

start_active_ym

character. start_active_ym when the project member became active

end_active_ym

character. end_active_ym when the project member became active

behaviour_flag

boolean. whether or not there was noteworthy behaviour of the volunteer

behaviour_description

character. description of the behaviour.

is_public

boolean. should the member be included in the project description on the website.

role_id

integer. id of the role of the project member.

role

integer. role of the project member. create a volunteer

Methods

Public methods

• ProjectMember$new()

• ProjectMember$to_tibble()

• ProjectMember$set_role()

• ProjectMember$set_behaviour()

• ProjectMember$get_sql_tables()

• ProjectMember$clone()

---

Method new()

Usage

ProjectMember$new(
  project_id,
  volunteer_id,
  role,
  start_active_ym = NA_character_,
  end_active_ym = NA_character_,
  behaviour_flag = FALSE,
  behaviour_description = NA_character_,
  is_public = FALSE
)

Arguments

project_id

character. ID of the project.

volunteer_id

integer. ID of the volunteer

role

character. name of the project role the team member assumes. Check projectutils::roles for available options.

start_active_ym

character. YYYY-mm when the team member became active in the team. defaults to NA

end_active_ym

character. YYYY-mm when the team member stopped being active in the team. defaults to NA

behaviour_flag

boolean. whether the team member exhibited any noteworthy behaviour. defaults to FALSE

behaviour_description

character. description of the behaviour. defaults to NA

is_public

boolean. whether or not the team member should be included on the public profile of the project on the CorrelAid website. defaults to FALSE. to_tibble

---

Method to_tibble()

returns a one row tibble representation of the Volunteer object. set_role

Usage

ProjectMember$to_tibble()

---

Method set_role()

Usage

ProjectMember$set_role(role)

Arguments

role

character. role of the volunteer. see projectutils::roles for available options. set_behaviour

---

Method set_behaviour()

Usage

ProjectMember$set_behaviour(flag, description = NA)

Arguments

flag

boolean. value of the flag for offending behaviour.

description

character. description of the offending behaviour. Defaults to NA_character_ , needs to be specified if setting the flag to TRUE. get_sql_tables

---

Method get_sql_tables()

a list function that returns tibble for each table

Usage

ProjectMember$get_sql_tables()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ProjectMember$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

CorrelAid/projectutils documentation built on Oct. 7, 2022, 4:40 a.m.