Project: Project class representing the basic properties of a...

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

Project class representing the basic properties of a CorrelAid Project

Description

Project class representing the basic properties of a CorrelAid Project

Project class representing the basic properties of a CorrelAid Project

Active bindings

tags

tibble. Returns the tags of the project as a tibble. Read-only.

local_chapters

tibble. Returns the local_chapters of the project as a tibble. Read-only.

description

tibble. Returns the description of the project as a Description object.

organization

tibble. Returns the organization of the project as a Organization object.

project_members

tibble. Returns the project_members of the project as a tibble. Read-only.

project_id

character. id of the project, in the form YYYY-mm-ABB where ABB is any three-character, uppercase abbreviation

name

character. title of the project.

status_id

integer. Returns integer corresponding to the status of the project. Check out projectutils::status to see the available status and the corresponding ids.

status

integer. Returns the status of the project. Check out projectutils::status to see the available status and the corresponding ids.

slug

character. Returns or sets the slug (the part of the URL after correlaid.org/projects) for the website. Must not contain spaces and only - as special characters.

is_public

boolean. Returns or sets whether the project is made public on the CorrelAid website. Use with caution!

start_ym

character. Return or set the start of the project, in YYYY-mm form. Does not change the project id.

end_ym

character. Return or set the actual end of the project, in YYYY-mm form.

end_ym_predicted

character. Return or set the predicted end of the project, in YYYY-mm form.

is_internal

boolean. Return or set whether or not the project is an internal project.

url_git_repo

character. Return or set the full URL of the git repository, either GitHub or Gitlab.

url_gh_issue

character. Returns the full URL to the GitHub issue in the projects repository. read-only. to set use num_gh_issue.

num_gh_issue

integer. Returns the number of the issue in the projects repository. read-only (use u)

team_size

integer. Team size of the project.

url_ideation_pad

character. Returns or sets the full URL to the CodiMD Pad for the ideation phase of the project.

url_call_pad

character. Returns or sets the full URL for the call for applications for the project.

slack_channel

character. Returns or sets the name of the Slack channel for the project.

organization_id

integer. Returns the three letter, uppercase ID corresponding to the partner organization of the project. e.g. COR for CorrelAid create a project

Methods

Public methods

• Project$new()

• Project$print()

• Project$add_tag()

• Project$add_local_chapter()

• Project$add_project_member()

• Project$get_team_member()

• Project$set_status()

• Project$to_tibble()

• Project$get_sql_tables()

• Project$to_website_json()

• Project$clone()

---

Method new()

Usage

Project$new(project_id, name)

Arguments

project_id

character. id of the project, in the form YYYY-mm-ABB where ABB is any three-character, uppercase abbreviation

name

character. Short title of the project. print

---

Method print()

print the project add a new tag to the project

Usage

Project$print()

---

Method add_tag()

Usage

Project$add_tag(category, value = NA)

Arguments

category

character. the tag category. see projectutils::tags for available values.

value

character. the tag value. see projectutils::tags for available values and combinations. Defaults to NA. add a local chapter to the project

---

Method add_local_chapter()

Usage

Project$add_local_chapter(lc_name)

Arguments

lc_name

character. local chapter name. see projectutils::local_chapters for available options. add a local chapter to the project

---

Method add_project_member()

Usage

Project$add_project_member(volunteer_id, role, ...)

Arguments

volunteer_id

integer. id of the volunteer.

role

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

...

optional arguments for ProjectMember constructor get team member by volunteer id

---

Method get_team_member()

Usage

Project$get_team_member(volunteer_id)

Arguments

volunteer_id

integer. numeric id of the volunteer. set status of the project

---

Method set_status()

Usage

Project$set_status(status)

Arguments

status

character. the status. See projectutils::status for options. to_tibble

---

Method to_tibble()

returns a one row tibble representation of the Project object. get_sql_tables

Usage

Project$to_tibble()

---

Method get_sql_tables()

function that returns a tibble for each table to_website_json

Usage

Project$get_sql_tables()

---

Method to_website_json()

function that returns list that can be used for the website (will need to add team separately)

Usage

Project$to_website_json()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Project$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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