From 268c56c20de05de0a69f2d20c7eb926bb8381011 Mon Sep 17 00:00:00 2001 From: drpatelh Date: Fri, 7 Aug 2020 09:31:54 +0100 Subject: [PATCH] Update README --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 37142ec6..fffec2f6 100644 --- a/README.md +++ b/README.md @@ -200,12 +200,14 @@ We also use a standardised parameter called `params.publish_dir_mode` that can b - Test files MUST be kept as tiny as possible. -- It is RECOMMENDED to re-use generic files from [`tests/data/`](tests/data/) by symlinking them into the [`test/`](software/fastqc/test) directory of the module. - -- If the appropriate test data doesn't exist for your module then it MUST be added to [`tests/data`](tests/data/). - - Every module MUST be tested by adding a test workflow with a toy dataset in the [`test/`](software/fastqc/test) directory of the module. +- Generic files from [`tests/data/`](tests/data/) SHOULD be reused by symlinking them into the [`test/input/`](software/fastqc/test/input/) directory of the module. + +- Any outputs produced by the test workflow SHOULD be placed in a folder called [`test/output/`](software/fastqc/test/output/) so that they can be used for unit testing. + +- If the appropriate test data doesn't exist for your module then it MUST be added to [`tests/data/`](tests/data/). + ### Documentation - A module MUST be documented in the [`meta.yml`](software/fastqc/meta.yml) file. It MUST document `params`, `input` and `output`. `input` and `output` MUST be a nested list.