RGIFTParser

The goal of RGIFTParser is to provide a parser for the GIFT format. The GIFT format is a simple and flexible way to create quizzes. It is used by the Moodle platform. The parser is using the parcr package.

Installation

You can install the development version of RGIFTParser from GitHub with:

# install.packages("devtools")
devtools::install_github("PascalCrepey/RGIFTParser")

Example

Let’s say you have questions in a GIFT format like that:

questions_gift = "
::Question 1::
Which planet is known as the Red Planet?
{
    =Mars#Correct! Mars is known as the Red Planet due to its reddish appearance.
    ~Earth#Incorrect. Earth is known as the Blue Planet.
    ~Venus#Incorrect. Venus is often called Earth's twin but not the Red Planet.
    ~Jupiter#Incorrect. Jupiter is the largest planet in our solar system.
    ~Saturn#Incorrect. Saturn is known for its prominent ring system.
}
#### Even color-blind people may answer this question correctly.
::Question 2::
What is the capital of France?
{
    =Paris#Correct! Paris is the capital of France.
    ~London#Incorrect. London is the capital of the United Kingdom.
    ~Berlin#Incorrect. Berlin is the capital of Germany.
    ~Madrid#Incorrect. Madrid is the capital of Spain.
    ~Rome#Incorrect. Rome is the capital of Italy.
}

::Question 3::
What is the chemical symbol for gold?
{
    =Au#Correct! Au is the chemical symbol for gold, derived from its Latin name 'Aurum'.
    ~Ag#Incorrect. Ag is the chemical symbol for silver.
    ~Fe#Incorrect. Fe is the chemical symbol for iron.
    ~Pb#Incorrect. Pb is the chemical symbol for lead.
    ~Hg#Incorrect. Hg is the chemical symbol for mercury.
}
"

Then, you can parse the questions with the following code:

library(RGIFTParser)

my_quiz = Quiz$new(questions_gift)

my_quiz
#> Quiz: 
#> Question: Question 1 ( No category )
#>  Which planet is known as the Red Planet? 
#> Answers: 
#>  Mars (True:  Correct! Mars is known as the Red Planet due to its reddish appearance.      )
#>  Earth (False:  Incorrect. Earth is known as the Blue Planet.      )
#>  Venus (False:  Incorrect. Venus is often called Earth's twin but not the Red Planet.      )
#>  Jupiter (False:  Incorrect. Jupiter is the largest planet in our solar system.      )
#>  Saturn (False:  Incorrect. Saturn is known for its prominent ring system. )
#> Feedback:   Even color-blind people may answer this question correctly. 
#> Question: Question 2 ( No category )
#>  What is the capital of France? 
#> Answers: 
#>  Paris (True:  Correct! Paris is the capital of France.      )
#>  London (False:  Incorrect. London is the capital of the United Kingdom.      )
#>  Berlin (False:  Incorrect. Berlin is the capital of Germany.      )
#>  Madrid (False:  Incorrect. Madrid is the capital of Spain.      )
#>  Rome (False:  Incorrect. Rome is the capital of Italy. )
#> Question: Question 3 ( No category )
#>  What is the chemical symbol for gold? 
#> Answers: 
#>  Au (True:  Correct! Au is the chemical symbol for gold, derived from its Latin name 'Aurum'.      )
#>  Ag (False:  Incorrect. Ag is the chemical symbol for silver.      )
#>  Fe (False:  Incorrect. Fe is the chemical symbol for iron.      )
#>  Pb (False:  Incorrect. Pb is the chemical symbol for lead.      )
#>  Hg (False:  Incorrect. Hg is the chemical symbol for mercury. )
#> Quiz containing  3  questions

If you prefer a simple list format instead of the R6 objects (Quiz, Question, Answer), you can use the GIFTParser function:

questions = GIFTParser(questions_gift)

invisible(lapply(questions, function(x) cat(x$title, ": ", x$text, "\n")))
#> Question 1 :  Which planet is known as the Red Planet? 
#> Question 2 :  What is the capital of France? 
#> Question 3 :  What is the chemical symbol for gold?