-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
102 lines (68 loc) · 4.71 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
91
92
93
94
95
96
97
98
99
100
101
102
---
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%"
)
```
# flashr <a href="https://jeffreyrstevens.github.io/flashr/"><img src="man/figures/logo.png" align="right" width="100" class="logo"/></a>
<!-- badges: start -->
[](https://www.repostatus.org/#active)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://cran.r-project.org/package=flashr)
[](https://CRAN.R-project.org/package=flashr)
[](https://github.com/JeffreyRStevens/flashr/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/JeffreyRStevens/flashr)
<!-- badges: end -->
Learning all of the functions needed to become proficient in R is a substantial undertaking. Flashcards are a great way to learn the syntax of computer languages (Hermans 2021). The goal of flashr (pronounced "flash-r") is to provide a quick way to view decks of flashcards.
flashr can use existing built-in flashcard decks hosted at the [flashr_decks GitHub repo](https://github.com/JeffreyRStevens/flashr_decks), including functions and arguments from [R for Data Science, first edition](https://r4ds.had.co.nz/) and [R for Data Science, second edition](https://r4ds.hadley.nz/) and glossaries from several [psyTeachR books](https://psyteachr.github.io/). Check out some [example decks](https://jeffreyrstevens.github.io/flashr_decks/decks.html).
In addition to built-in decks, you can easily create your own decks using CSV files. This allows you to customize existing decks or create completely new decks. Also, while geared toward learning R, this package can be used to build decks for anything---not just computer syntax!
## Installation
You can install the stable released version of flashr from [CRAN](https://cran.r-project.org/package=flashr) with:
```{r eval = FALSE}
install.packages("flashr")
```
You can install the development version of flashr like so:
```{r eval = FALSE}
# install.packages("remotes")
remotes::install_github("JeffreyRStevens/flashr")
```
## Example
To view, for example, the flashcard deck on data types:
```{r eval = FALSE}
library(flashr)
flashcard("data_types")
```
This randomizes the order of terms and give terms before descriptions. If you would like to present descriptions before terms:
```{r eval = FALSE}
flashcard("data_types", termsfirst = FALSE)
```
<img src="man/figures/flashr.gif" alt="GIF of RStudio IDE console showing
the loading of flashr \[library(flashr)\] and the creation of a data
types deck with flashcard('data_types'). The deck opens in the viewer
where terms and descriptions are clicked through.">
## Building decks
To build your own deck, save a CSV file with a `term` column and a `description` column. You can also include a `package` column if you want the package name included with the term and a `title` column if you want to specify the title of the deck.
```{r}
my_deck <- read.csv("inst/extdata/operators.csv")
head(my_deck)
```
Then run the `flashcard()` function on your file.
```{r eval = FALSE}
flashcard("inst/extdata/operators.csv")
```
Check out the [Get Started vignette](https://jeffreyrstevens.github.io/flashr/articles/flashr.html#creating-your-own-decks) for more details on creating your own flashcard deck.
## Citation
To cite flashr, use:
> Stevens, Jeffrey R. (2024). flashr: Creates flashcards of terms and definitions. (version 0.2.0) https://cran.r-project.org/package=flashr
## Contributing to this package
Contributions to flashr are most welcome! Feel free to check out [open issues](https://github.com/JeffreyRStevens/flashr/issues) for ideas. And [pull requests](https://github.com/JeffreyRStevens/flashr/pulls) are encouraged, but you may want to [raise an issue](https://github.com/JeffreyRStevens/flashr/issues) or [contact the maintainer](mailto:[email protected]) first.
## Acknowledgments
This work was funded by US National Science Foundation grant NSF-1658837.
## References
Hermans, F. (2021). The Programmer’s Brain. Manning. [https://www.manning.com/books/the-programmers-brain](https://www.manning.com/books/the-programmers-brain)