summaryrefslogtreecommitdiff
path: root/doc/cli.markdown
diff options
context:
space:
mode:
authorCalvin <calvin@EESI>2013-03-13 14:15:22 -0400
committerCalvin <calvin@EESI>2013-03-13 14:15:22 -0400
commit7127badd2a1ba320eb96fea0d5543664d92912c4 (patch)
treee281feae6ec6f6ea8b6b7b839d9f0f5282a682b2 /doc/cli.markdown
parentc6398e29628d57eca7cd481623decf7ce337b2d6 (diff)
added matlab markdown and edited cli
Diffstat (limited to 'doc/cli.markdown')
-rw-r--r--doc/cli.markdown5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/cli.markdown b/doc/cli.markdown
index c7f8e11..8d25337 100644
--- a/doc/cli.markdown
+++ b/doc/cli.markdown
@@ -26,6 +26,9 @@ Quikr returns the estimated frequencies of batcteria present when given a
input FASTA file. A default trained matrix will be used if none is supplied
You must supply a kmer and default lambda if using a custom trained matrix.
+### Usage ###
+quikr returns the solution vector as a csv file.
+
quikr's optional arguments:
-f, --fasta, the fasta file sample
-o, --output OUTPUT, the output path (csv output)
@@ -34,7 +37,7 @@ quikr's optional arguments:
-k, --kmer, this specifies which kmer to use (default is 6)
-### Troubleshooting ###
+# Troubleshooting #
If you are having trouble, and these solutions don't work. Please contact the
developers with questions and issues.