https://github.com/correlaid/projectutils
Utility R package for CorrelAid project coordination.
https://github.com/correlaid/projectutils
Last synced: 9 months ago
JSON representation
Utility R package for CorrelAid project coordination.
- Host: GitHub
- URL: https://github.com/correlaid/projectutils
- Owner: CorrelAid
- License: other
- Created: 2020-10-30T13:47:29.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-09-30T15:28:00.000Z (almost 4 years ago)
- Last Synced: 2023-04-25T11:50:57.809Z (about 3 years ago)
- Language: R
- Size: 374 KB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.Rmd
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
---
title: "projectutils"
output: github_document
---
[](https://codecov.io/gh/CorrelAid/projectutils)
[](https://github.com/CorrelAid/projectutils/actions)
[](https://www.tidyverse.org/lifecycle/#experimental)
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```
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](https://docs.correlaid.org/project-manual/project-coordinators).
## Installation
This package is only available on GitHub and there are no plans to submit it to CRAN.
with `{devtools}` :package:
```{r eval=FALSE}
devtools::install_github("CorrelAid/projectutils")
```
or with the `{remotes}` :package:
```{r eval=FALSE}
remotes::install_github("CorrelAid/projectutils")
```
install the development version from the `dev` branch (experimental, for development):
```{r eval=FALSE}
remotes::install_github("CorrelAid/projectutils", ref = "dev")
```
## Manage project data
This package can help you to create and update entries for the [CorrelAid project "database"](https://github.com/correlaid/projectsdb). For instructions related to this functionality, please refer to the README of the [CorrelAid project "database"](https://github.com/correlaid/projectsdb).
## Manage team selection
`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:
```{r eval=FALSE}
use_team_selection_workflow("2020-12-TES")
```
#### 01_{prefix}_prepare_team_selection.R
- download applications from [kobotoolbox](https://kobo.correlaid.org) 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
#### 02_{prefix}_send_confirmation_emails.R
- based on the `applicant_id`s 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.
#### Report templates
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.
## Reporting on projects
Yet to be implemented:
- reports on the feedback on the project from NPOs
- reports on the feedback on the project from volunteers