flashr

Creates Flashcards of Terms and Definitions

https://github.com/jeffreyrstevens/flashr

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (21.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Creates Flashcards of Terms and Definitions

Basic Info
Statistics
  • Stars: 10
  • Watchers: 1
  • Forks: 1
  • Open Issues: 1
  • Releases: 8
Created about 4 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License Codemeta

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# flashr 


[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/flashr)](https://cran.r-project.org/package=flashr)
[![Total Downloads](https://cranlogs.r-pkg.org/badges/grand-total/flashr)](https://CRAN.R-project.org/package=flashr)
[![R-CMD-check](https://github.com/JeffreyRStevens/flashr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/JeffreyRStevens/flashr/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/JeffreyRStevens/flashr/graph/badge.svg)](https://app.codecov.io/gh/JeffreyRStevens/flashr)


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)
```

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}`](https://jeffreyrstevens.github.io/flashr/), use:

```{r echo=FALSE, results='asis'}
print(readCitationFile("inst/CITATION"), style = "text")
```

## 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:jeffrey.r.stevens@protonmail.com) 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)

Owner

  • Name: Jeffrey Stevens
  • Login: JeffreyRStevens
  • Kind: user
  • Location: Lincoln, NE
  • Company: Canine Cognition and Human Interaction Lab, @UNL

Associate professor, Department of Psychology, Center for Brain, Biology & Behavior, @UNL. Data Science Mentor at Posit.

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "flashr",
  "description": "Provides functions for creating flashcard decks of terms and definitions. This package creates HTML slides using 'revealjs' that can be viewed in the 'RStudio' viewer or a web browser. Users can create flashcards from either existing built-in decks or create their own from CSV files or vectors of function names.",
  "name": "flashr: Create Flashcards of Terms and Definitions",
  "relatedLink": "https://jeffreyrstevens.github.io/flashr/",
  "codeRepository": "https://github.com/JeffreyRStevens/flashr",
  "issueTracker": "https://github.com/JeffreyRStevens/flashr/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "0.3.0",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.5.0 (2025-04-11)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Jeffrey R.",
      "familyName": "Stevens",
      "email": "jeffrey.r.stevens@protonmail.com",
      "@id": "https://orcid.org/0000-0003-2375-1360"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Person",
      "givenName": "Jeffrey R.",
      "familyName": "Stevens",
      "email": "jeffrey.r.stevens@protonmail.com",
      "@id": "https://orcid.org/0000-0003-2375-1360"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Jeffrey R.",
      "familyName": "Stevens",
      "email": "jeffrey.r.stevens@protonmail.com",
      "@id": "https://orcid.org/0000-0003-2375-1360"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "covr",
      "name": "covr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=covr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "litedown",
      "name": "litedown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=litedown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "withr",
      "name": "withr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=withr"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 2.10"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "cli",
      "name": "cli",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=cli"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "curl",
      "name": "curl",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=curl"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "gh",
      "name": "gh",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=gh"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "httr",
      "name": "httr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=httr"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "memoise",
      "name": "memoise",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=memoise"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "revealjs",
      "name": "revealjs",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=revealjs"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    "9": {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    },
    "10": {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils"
    },
    "SystemRequirements": null
  },
  "fileSize": "3650.939KB",
  "citation": [
    {
      "@type": "SoftwareSourceCode",
      "datePublished": "2025",
      "author": [
        {
          "@type": "Person",
          "givenName": [
            "Jeffrey",
            "R."
          ],
          "familyName": "Stevens"
        }
      ],
      "name": "flashr: Create Flashcards of Terms and Definitions",
      "url": "https://github.com/JeffreyRStevens/flashr",
      "description": "R package version 0.3.0"
    }
  ]
}

GitHub Events

Total
  • Create event: 2
  • Release event: 2
  • Issues event: 11
  • Watch event: 3
  • Issue comment event: 10
  • Push event: 37
  • Pull request event: 2
Last Year
  • Create event: 2
  • Release event: 2
  • Issues event: 11
  • Watch event: 3
  • Issue comment event: 10
  • Push event: 37
  • Pull request event: 2

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 11
  • Total pull requests: 19
  • Average time to close issues: 3 months
  • Average time to close pull requests: 28 minutes
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 1.18
  • Average comments per pull request: 0.0
  • Merged pull requests: 19
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 6
  • Pull requests: 2
  • Average time to close issues: 4 days
  • Average time to close pull requests: 7 minutes
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • JeffreyRStevens (8)
  • sagrules (4)
Pull Request Authors
  • JeffreyRStevens (21)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 536 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 2
  • Total versions: 5
  • Total maintainers: 1
cran.r-project.org: flashr

Create Flashcards of Terms and Definitions

  • Versions: 5
  • Dependent Packages: 1
  • Dependent Repositories: 2
  • Downloads: 536 Last month
Rankings
Dependent packages count: 18.1%
Dependent repos count: 19.3%
Stargazers count: 20.6%
Forks count: 21.0%
Average: 27.2%
Downloads: 57.2%
Last synced: 10 months ago

Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • cli * imports
  • gh * imports
  • memoise * imports
  • revealjs * imports
  • rmarkdown * imports
  • covr * suggests
  • knitr * suggests
  • testthat >= 3.0.0 suggests
  • withr * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite