... or Lit-pro-sci-pub-demo.

This is the repository for an R file that demonstrates the concept of Literate Programming applied to scientific publishing.

Literate Programming combines data analysis with documentation. It can therefore contribute to reproducible research by enabling reproducibilty.

All of the data processing and documentation contained in this directory was generated by rendering the main.rmd file.

Conceivably, Literate Programming could be combined with a Docker image of all of the data for complete portability of results. This is discussed in more detail in main.PDF.

• A working R installation. This can be obtained from http://www.r-project.org. You may find RStudio to be a good IDE.
• A working LaTeX installation. This can be obtained from https://www.latex-project.org/get/.
• Pandoc. I suggest you start with the instructions for installing pandoc.
• Patience and a sense of humour.

I've split this off into the HOWTO.md file.

Documentation is provided in the publications directory in several forms:

• as main.pdf, which is a normal PDF,
• as main.html, which can be read in any browser, and
• as main.md, which is Github-flavoured markup and is displayed by GitHub.

All of these files are generated from main.Rmd. That's kind of the point of Literate Programming; your code is your documentation, and vice-versa.

You can find the most recent stable version of this code in the releases part of this repository.

This software is provided as is, with no guarantees.

Please use the issue tracker to report problems or request improvements.

• Andy Clifton

You can get in contact with me by raising an issue.

This project is licensed under the MIT License - see the LICENSE file for details.

• Many thanks to Nikola Vasiljevic at DTU for encouraging me to get this written up.

END OF FILE