Homec4science
Diffusion Numerical Data For Moodle (pandoc-converter) Browse

NumDataMoodle/doc/source/en_Howto_main.Rnw
3189c9372675pandoc-converter

Last Change
Raw File

en_Howto_main.Rnw
View Options

% !TeX root = ../teach.Moodle.Latex.R
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% %%
%% Pastille %%
%% main %%
%% %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Conception : Main}
\begin{frame}
\frametitle{The orchestra conductor}
The {\it\textcolor{vertmoyen}{exo.Moodle.template.R}} file is the orchestra conductor.
Its purpose is
\begin{itemize}
\pause
\item to indicate where the files are located
\begin{itemize}
\item statements (i.e. *.Rnw)
\item data composition and calculations (i.e. *.R)
\item generated output (*.xml or *.pdf)
\item possible images
\item static data, if any
\end{itemize}
\pause
\item initialize the seed of random numbers to be generated
\pause
\item to generate the result (i.e. HTML, pdf or XML)
\end{itemize}
\vspace{5mm}
\begin{beamerboxesrounded}%
[scheme=CommandeRouge, shadow=false]
{Explanation}
{\it\textcolor{vertmoyen}{exo.Moodle.template.R}} must be executed to produce the result.
\end{beamerboxesrounded}
\end{frame}
\begin{frame}[fragile]
\frametitle{Main : content}
\begin{columns}[T] % align columns
\begin{column}{.48\textwidth}
Loading libraries
{\tiny
<<eval = FALSE, message=FALSE, warning=FALSE>>=
## load package
if(!require("knitr")) install.packages("knitr")
if(!require("tth")) install.packages("tth")
if(!require("base64enc")) install.packages("base64enc")
if(!require("exams")) install.packages("exams")
library("exams")
@
}
{\scriptsize
\begin{beamerboxesrounded}%
[scheme=CommandeRouge, shadow=false]
{Explanation}
If the libraries have not yet been downloaded once (part {\it if(...)}, then they will be.
Next, the "exams" library is loaded into memory. \end{beamerboxesrounded}
}
\end{column}%
\hfill%
\pause
\begin{column}{.48\textwidth}
Directory specification
{\tiny
<<eval = FALSE>>=
currentdir.wd <- getwd()
script.path <- paste0(currentdir.wd, "/source/R/")
# for data export
data.path <- paste0(currentdir.wd, "/source/data/")
fig.path <- paste0(currentdir.wd, "/source/fig/")
@
}
{\scriptsize
\begin{beamerboxesrounded}%
[scheme=CommandeRouge, shadow=false]
{Explanation}
The files are in separate directories for greater clarity.\\
source/R for data composition and calculation files (*.R)\\
source/data for storage of generated or static data\\
source/fig for storing static figures
\end{beamerboxesrounded}
}
\end{column}%
\end{columns}
\end{frame}
\begin{frame}[fragile]
\frametitle{Main : content}
\begin{columns}[T] % align columns
\begin{column}{.48\textwidth}
Seed and statement
{\tiny
<<eval = FALSE>>=
# set the seed
set.seed(2022)
# set the exercises
exo <- c("prefixe_template_specific.Rnw")
@
}
{\scriptsize
\begin{beamerboxesrounded}%
[scheme=CommandeRouge, shadow=false]
{Explanation}
{\it set.seed()} initializes the seed so that the result can be regenerated with the same data.\\
{\it exo} contains the list of question files. \end{beamerboxesrounded}
}
\end{column}%
\hfill%
\pause
\begin{column}{.48\textwidth}
Exporting to HTML
{\tiny
<<eval = FALSE>>=
# export as HTML for a quick check
exams2html(
file = exo,
encoding = "UTF-8",
edir = "./source",
template = "plain8",
n = 1
)
@
}
{\scriptsize
\begin{beamerboxesrounded}%
[scheme=CommandeRouge, shadow=false]
{Explanation}
Exporting to HTML allows you to quickly see a result close to what will be generated.\\
{\it n=1} indicates that only one copy is generated.
\end{beamerboxesrounded}
}
\end{column}%
\end{columns}
\end{frame}
\begin{frame}[fragile]
\frametitle{Main : content}
Export to XML
{\tiny
<<eval = FALSE>>=
# generate Moodle exo XML file
exams2moodle(
file = exo,
name = "2022.Template",
encoding = "UTF-8",
converter = "ttm",
dir = "output",
cloze = list(
cloze_mchoice_display = "MULTIRESPONSE",
shuffle = TRUE,
eval = list(
partial = TRUE,
negative = FALSE,
rule = "true"
)
),
edir = "source",
rule = "none",
n = 1
)
@
}
{\scriptsize
\begin{beamerboxesrounded}%
[scheme=CommandeRouge, shadow=false]
{Explanation : XML export importable by Moodle}
Produces the file that will be imported into the question database.\\
{\it\textcolor{vertmoyen}{name =}} name of the directory in the question bank.\\
There is 1 sub-directory created per statement file, which will contain {\it\textcolor{vertmoyen}{n}} versions of the statement.
\end{beamerboxesrounded}
}
\end{frame}
c4science · Help