-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
90 lines (70 loc) · 2.85 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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
<!-- badges: start -->
[](https://github.com/tntp/tntpr/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
<a href="https://tntp.org" target="_blank">
{width=70px height=70px}
</a>
# tntpr
About
-----
The `tntpr` package contains an assortment of functions and templates
customized to meet the needs of data analysts at the non-profit organization
TNTP. It includes functions for branded colors and plots, credentials
management, repository set-up, and other common analytic tasks.
Package summary
---------------
Some of the highlights of the package include:
- TNTP brand colors and palettes with the `tntp_colors()` and
`tntp_palette()` functions
- A TNTP ggplot2 theme using brand fonts (`tntp_style()`)
- The `tntp_cred()` functions for securely managing credentials (passwords,
API keys, etc.).
- The `sp_*()` functions for interacting with Sharepoint through R.
- TNTP-themed RMarkdown templates, for starting a new analysis with a
shell that can already generate a TNTP-themed .docx report
- Functions for initializing a new repository or project folder with
TNTP-standard directories and documentation
- Survey analysis tools such as `factorize_df()`, `recode_to_binary()`,
and functions for dealing with check-all style questions
- Wrappers for quickly making typical TNTP-style charts (e.g., bar
chart of means on variable 1 grouped by variable 2)
- Education-specific data management functions (e.g., `date_to_sy()`
to convert continuous hire dates into school years using a specified
cutoff date)
- Built-in fake data sets to practice with, including student achievement
data (`wisc`), teacher data (`fake_county`) and survey data
(`teacher_survey`)
`tntpr` is built to work with the tidyverse set of packages.
Installing the `tntpr` package
------------------------------
You can install `tntpr` from CRAN as follows:
```{r eval=FALSE}
install.packages('tntpr')
```
You can also install this package from its GitHub repository using `devtools`.
If you do not have the `devtools` package installed, you will have to run the
first line in the code below as well:
```{r eval=FALSE}
# install.packages('devtools')
devtools::install_github('tntp/tntpr')
```
Once installed, you load it like any other package.
```{r}
library(tntpr)
```
Feature Requests and Bug Reports
--------------------------------
Have a data problem you think `tntpr` could help with? Find a bug while
working with the `tntpr` package? Please create an issue.