priism-center / shinyquiz Goto Github PK

FEATURE LIST

• mvp

  • Easy-mode pre-generated question structure @gperrett
  • Sandbox-mode that has quasi-infinite questions
    • Function that randomly generates questions @gperrett

• wishlist

  • Print-out grade report -- html and pdf version @joemarlo
  • Google Sheets write out results
  • Rmarkdown / quarto support
  • Styling themes
  • Different layouts
  • On final menu, hover over row to preview question
  • Pipeable quiz object for easy modification
  • Make quiz object modifiable so quiz can be adjusted on-the-fly within Shiny?

QUIZ WRITER API @gperrett

• Create a user friendly API that can create questions and output as HTML
• Output should be HTML for question, function for grader, function for user answer printer, correct answer printer
• Create a preview that spins up a shiny app to test in RStudio
  • Create preview that shows only html, no interactivity
• Create method of generating infinite questions

STATE MACHINE / CORE LOGIC @joemarlo

• Create test quiz
• S4 classes for quiz, quiz questions
• Sandbox mode vs end early mode
• Constructors that interface between the user-friendly code and the backend
• Need function that takes in raw HTML
• Move messages into an object
• BUG: shows quiz skipped when getting one wrong (not in sandbox mode)
• Add option to make 'end early' mode optional

SHINY INTEGRATION @joemarlo

• How to make this play nicely with Shiny
• How is the namespace handled
  • Change id, id_parent args to ns
• Add style sheets
• Convert to input/output paradigm? https://book.javascript-for-r.com/shiny-output.html

TACTICAL

• Move over code from thinkCausal repo @joemarlo
• Structure as an R package @joemarlo
• Move repo to PRIISM @joemarlo
• Move current thinkCausal quizzes to shinyQuiz structure
• Unit tests
• Examples
• Review need for \dontrun{}
• Add example app running on shinyapps.io