-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
73 lines (50 loc) · 2.98 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
---
title: "projectutils"
output: github_document
---
<!-- badges: start -->
[](https://codecov.io/gh/CorrelAid/projectutils)
[](https://github.com/CorrelAid/projectutils/actions)
[](https://www.tidyverse.org/lifecycle/#experimental)
<!-- badges: end -->
```{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