This R package aims to make it easier to coordinate CorrelAid projects by providing utility functions. Additional, more text-focused help can be found in the documentation for project coordinators.
This package is only available on GitHub and there are no plans to submit it to CRAN.
with {devtools} 📦
devtools::install_github("CorrelAid/projectutils")or with the {remotes} 📦
remotes::install_github("CorrelAid/projectutils")install the development version from the dev branch (experimental, for
development):
remotes::install_github("CorrelAid/projectutils", ref = "dev")This package can help you to create and update entries for the CorrelAid project “database”. For instructions related to this functionality, please refer to the README of the CorrelAid project “database”.
projectutils provides templates for scripts with all the necessary
workflow steps for team selection.
Those templates can be installed / created in a (newly created)
team_selection subfolder with:
use_team_selection_workflow("2020-12-TES")- download applications from kobotoolbox
and do data cleaning (
load_applications()) - anonymize applications (
anonymize_applications()) - store the mapping of applicant_ids to emails and names
- knit a PDF report that includes helpful visualizations of the self-rating questions as well as the answers to the open-ended questions
- based on the
applicant_ids of the selected team members, extract the email addresses of the selected / declined applicants and write a “;” - separated string to the clipboard for convenient copy-pasting into Outlook.
Executing use_team_selection_workflow() will also create two RMarkdown
templates in the folder. Those are supposed to be knitted by
01_{prefix}_prepare_team_selection.R and not directly. You can adapt
them if needed.
Yet to be implemented:
- reports on the feedback on the project from NPOs
- reports on the feedback on the project from volunteers