Forked from pikrol/CDI-IRT:master
Currently the repository lets you do two things:
- run IRT model fitting (with
fit-template.Rmd) - run a set of analyses and simulations using such a model (with
sim-template.Rmd)
fit-template.Rmd needs the relevant data (see the file for details) to work.
sim-template.Rmd needs the successful run of fit-template.Rmd on the relevant data to work.
You shouldn't (have to) modify anything in the files (unless a chunk explicitly states otherwise); you'll be asked for the data you want to run them on, when you try running or knitting them.
Both files contain potentially time-consuming chunks. These chunks show their progress in the console (if possible) and their results are saved, so that next time you run the code the results are loaded, rather than recomputed.
Knitting is not allowed until you first run the whole code interactively,
so that you can observe all those progress bars and other important messages,
which would be difficult during the knitting process.
Also, by default, knitting is allowed only by running knit_from_template.R
(it will ask for necessary details1), which takes care of the output file's name
and location.2
Subdirectories:
-
Functionsdirectory contains required function definitions. -
Reportsdirectory contains knitted reports.3 -
Datadirectory is used for saving and loading data (raw CDI, interim & final models, simulations etc.).4
Archivedirectory contains lots of old and possibly still useful and/or interesting stuff. Content in all its subdirectories other thanArchive/Rmd_2_0comes from the forked pikrol/CDI-IRT.
Footnotes
-
knit_from_template.Raccepts command line arguments as well, which can be useful for batch processing (seebatch_example.sh), but be careful with them --- there is no error handling whatsoever. ↩ -
You can use RStudio "knitting with parameters" but the generated report file won't be properly named and placed. ↩
-
knit_from_template.Rby default saves them there. ↩ -
It's gitignored because of the size of
RDatafiles and to avoid issues with data sharing. ↩