https://github.com/jienagu/flashCard

R package to create a flash Card.
https://github.com/jienagu/flashCard

Last synced: 3 months ago
JSON representation

R package to create a flash Card.

• Host: GitHub
• URL: https://github.com/jienagu/flashCard
• Owner: jienagu
• License: other
• Created: 2020-08-07T00:50:46.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-01-10T00:55:23.000Z (almost 3 years ago)
• Last Synced: 2024-05-14T07:33:37.344Z (6 months ago)
• Language: R
• Size: 196 KB
• Stars: 36
• Watchers: 4
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-shiny-extensions - flashCard - HTML widget for creating flippable flash cards. (UI Components / Walkthrough / Tooltip / Help)

README

        


# flashCard 

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/flashCard)](https://cran.r-project.org/package=flashCard)

[![Download](https://cranlogs.r-pkg.org/badges/grand-total/flashCard)](https://cranlogs.r-pkg.org/badges/grand-total/flashCard)

Here is a Shiny demo repo: https://github.com/jienagu/flashCard_Shiny_Demo

Live Demo on shinyapp.io: https://appforiarteam.shinyapps.io/flashCard_demo/

Live podcast tutorial on 32:38 : https://shinydevseries.com/post/episode-16-jmclellan/

## Installation

``` r

install.packages("flashCard")

```

This is package is to create a flash card for Shiny application with

desired data.frame.

## Introduction

Simply create a data frame with `front` column and `back` column. Then

put this data frame into `flashCard()` function, we will get a nice

flash card.

``` r

library(flashCard)

df1 <- data.frame(

  front = c("Title front","contentfront", "content second line"),

  back =c("Title back","content back", "second line")

)

flashCard(df1, elementId = "card", front_text_color = "white")

```

![demo_gif](man/figures/flashCard.gif)

## Feature update

Users can use `text_align` to customize text alignment in the flash Card, please use developer version (v0.1.1) to test it out!

* Dev version installation

``` r

devtools::install_github("jienagu/flashCard")

```

* Example

``` r

library(flashCard)

df1 <- data.frame(

  front = c("Title front","contentfront", "content second line"),

  back =c("Title back","content back", "second line")

)

flashCard(df1, elementId = "card", front_text_color = "white", text_align = "left", 

          width = "300px")

```



## App examples

* Ganapathy Palanimuthu's Flash Card App repo: https://github.com/ganapap1/FlashCard/tree/main.  YouTube Demo: https://www.youtube.com/watch?v=x59NfU0NsRw