Volunteer: Volunteer class representing a CorrelAid Volunteer

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

Volunteer class representing a CorrelAid Volunteer

Description

Volunteer class representing a CorrelAid Volunteer

Volunteer class representing a CorrelAid Volunteer

Active bindings

first_name

character. first_name of the volunteer

last_name

character. last_name of the volunteer

email

character. Email of the volunteer

user_gh

character. github username of the volunteer.

user_gl

character. gitlab username of the volunteer.

user_twitter

character. twitter username of the volunteer.

url_website

character. personal website of the volunteer.

url_linkedin

character. url to the linkedin profil of the volunteer

url_xing

character. url to the xing profil of the volunteer

lc_id

integer. Returns the integer corresponding to the local chapter of the volunteer. create a volunteer

Methods

Public methods

• Volunteer$new()

• Volunteer$to_tibble()

• Volunteer$set_local_chapter()

• Volunteer$get_sql_tables()

• Volunteer$clone()

---

Method new()

Usage

Volunteer$new(
  first_name,
  last_name,
  email,
  user_gh = NA_character_,
  user_gl = NA_character_,
  user_twitter = NA_character_,
  url_website = NA_character_,
  url_linkedin = NA_character_,
  url_xing = NA_character_,
  lc_name = NA_character_
)

Arguments

first_name

character. first name of the volunteer

last_name

character. last name of the volunteer

email

character. email of the volunteer

user_gh

character. GitHub username of the volunteer. defaults to NA

user_gl

character. GitLab username of the volunteer. defaults to NA

user_twitter

character. Twitter username of the volunteer. defaults to NA

url_website

character. Personal website of the volunteer. defaults to NA

url_linkedin

character. URL to Linkedin profile of the volunteer. defaults to NA

url_xing

character. URL to Xing profile of the volunteer. defaults to NA

lc_name

character. Name of the local chapter of the volunteer. defaults to NA to_tibble

---

Method to_tibble()

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

Usage

Volunteer$to_tibble()

---

Method set_local_chapter()

sets the local chapter of the volunteer get_sql_tables

Usage

Volunteer$set_local_chapter(lc_name)

Arguments

lc_name

name of the local chapter. see projectutils::local_chapters for options.

---

Method get_sql_tables()

a list function that returns tibble for each table

Usage

Volunteer$get_sql_tables()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Volunteer$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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