diff options
Diffstat (limited to 'reproducible-paper.tex')
| -rw-r--r-- | reproducible-paper.tex | 81 |
1 files changed, 70 insertions, 11 deletions
diff --git a/reproducible-paper.tex b/reproducible-paper.tex index 9543f6e..8cebe7b 100644 --- a/reproducible-paper.tex +++ b/reproducible-paper.tex @@ -101,7 +101,15 @@ top color=white, bottom color=green!50!black!20 } } - +%% For the make demo +\newcommand{\makedemoslide}[2] { + \begin{frame}{#2} + \begin{center}\includegraphics[width=0.8\linewidth]{#1}\end{center} + \footnotesize \textcolor{green!50!black}{Green boxes} are \emph{source} + files (hand-written), \textcolor{blue}{Blue boxes} are \emph{built} + files (automatically generated). + \end{frame} + } @@ -883,10 +891,41 @@ - \begin{frame}{With Make, we can record the full data lineage} - \centering - \includegraphics[width=0.8\linewidth]{img/analysis-diagram.pdf} - \end{frame} + %% Make demo. + \makedemoslide{img/make-demo-1-raw.pdf} + {Source files (containing instructions and configuration parameters).} + \makedemoslide{img/make-demo-2-input1.pdf} + {First built/output file (downloaded dataset).} + \makedemoslide{img/make-demo-3-out1a.pdf} + {Downloaded file is used to build analysis-1's first output.} + \makedemoslide{img/make-demo-4-out3a.pdf} + {Second built file is for analysis-3, also depends on + a value in a configuration file.} + \makedemoslide{img/make-demo-5-out2a.pdf} + {First input is also used to build another file (using + two configuration parameters).} + \makedemoslide{img/make-demo-6-out3b.pdf} + {\texttt{out-bb.dat} is built after \texttt{out-2a.dat}.} + \makedemoslide{img/make-demo-7-input2.pdf} + {We now need a second input file, which is downloaded.} + \makedemoslide{img/make-demo-8-out1b.pdf} + {\texttt{out-1b.dat} depends on \texttt{out-1a.dat}, + \texttt{input2.dat} and \texttt{param-1.conf}.} + \makedemoslide{img/make-demo-9-out2b.pdf} + {SUMMARY: The exact lineage of data is thus recorded in Makefiles.} + + + + + + + + + + + + + @@ -959,12 +998,32 @@ \end{center} \end{frame} - \begin{frame}{We have the full data lineage (raw input $\rightarrow$ every number and plot in paper's PDF)} - \centering - \includegraphics[width=0.8\linewidth]{img/analysis-diagram.pdf} - \end{frame} - - + \makedemoslide{img/make-demo-9-out2b.pdf} + {Recall that the data lineage was already recorded in Makefiles.} + \makedemoslide{img/make-demo-10-texsources.pdf} + {Makefiles are also used to connect the analysis with with paper.} + \makedemoslide{img/make-demo-11-downloadtex.pdf} + {Information from the raw inputs is stored in \texttt{download.tex}.} + \makedemoslide{img/make-demo-12-analysis1tex.pdf} + {Values to report from the first analysis step are kept in + \texttt{analysis1.tex}.} + \makedemoslide{img/make-demo-13-analysis2tex.pdf} + {Values to report from the second analysis step are kept in + \texttt{analysis2.tex}.} + \makedemoslide{img/make-demo-14-analysis3tex.pdf} + {Values to report from the third analysis step are kept in + \texttt{analysis3.tex}.} + \makedemoslide{img/make-demo-15-initializetex.pdf} + {General project information are stored in \texttt{initialize.tex}.} + \makedemoslide{img/make-demo-16-projectex.pdf} + {All the \TeX{} macros are loaded into the single + \texttt{project.tex} (after the analysis is complete).} + \makedemoslide{img/make-demo-17-paper.pdf} + {With the paper's \LaTeX{} source, \texttt{project.tex} is + used to build the final PDF paper.} + \makedemoslide{img/make-demo-17-paper.pdf} + {Full data lineage (raw input $\leftrightarrow$ every + number/paragraph and plot in paper's PDF) is recorded.} |