This module converts markdown files to LaTeX PDF (separately or as a single document) using Pandoc.
Bulleted list that points out each task performed by the module.
- Process a specific kind of data.
- Generate a result.
Your markdown document, dah.
Within you markdown document, images must be referenced using the visuals/image-file
address (e.g. visuals/funny-pic.jpg
).
List and describe the input files of this module. Add perinent considereations.
Format of files.
Name of files.
Number of files.
List and describe output files and their relationship to input files.
Create a symlink to your (unique) images directory in this module (i.e. ln -s /your/directory/ images
)
How to set up the module to perform an analysis (where to place input data, commands used to run the module).
$ bin/create-targets | xargs mk
The output files will be placed under the results/
directory after the analysis runs.
Include theoretical aspects relevant to the module's functioning and/or the biological problem that it solves. Describe used algorithms and their implementation as programs' parameters.
Describe the modules strategy to assess the results of this module given the input data. Include information about running the qc.
$ mk qc
Explain parameters and/or additional options for the analysis than can be set by environment variables (included in the config.mk
file).
List the software dependencies of this module and their download link if applicable.
List the references consulted by this README file.