aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin Bedo <cu@cua0.org>2018-12-20 15:23:22 +1100
committerJustin Bedo <cu@cua0.org>2018-12-20 15:23:22 +1100
commitfd497e038d6fe72cef476600496c70aa135ef297 (patch)
tree573278e1c90b2f8e10b118803ec1934aaee3eb8e
parent4aaf973ac64e284f7408aed208debde6eb36d756 (diff)
README: add tnpair example to examples section
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 92817c2..e5805a8 100644
--- a/README.md
+++ b/README.md
@@ -9,12 +9,16 @@ documentation is sparse.
Install [Nix](http://nixos.org/nix) and then try `nix-build` in the examples
directory.
-## Example pipeline
+## Example pipelines
The examples directory shows a simple pipeline in the call.nix and default.nix
files. You can build it with `nix-build` in the examples directory. The result
will be linked to ./result, which in this example case is an empty VCF file.
+There is another tumour-normal pipeline calling example consisting of `tnpair`
+and `tnpair.nix`. In this case, the shell script tnpair accepts a reference and
+two fastq files to run the pipeline defined in `tnpair.nix` on.
+
## Contact
Please come chat with us at [#bionix:cua0.org](http://matrix.to/#/#bionix:cua0.org).