|
a |
|
b/docs/usage/MetCLI.md |
|
|
1 |
<h2 id="usage">Command-Line Interface (CLI) Usage |
|
|
2 |
</h2> |
|
|
3 |
|
|
|
4 |
DNAnalyzer uses CLI arguments instead of `stdin`. For example, you can do: |
|
|
5 |
|
|
|
6 |
``` |
|
|
7 |
<executable> assets/dna/random/dnalong.fa --amino=ser |
|
|
8 |
``` |
|
|
9 |
|
|
|
10 |
or |
|
|
11 |
|
|
|
12 |
``` |
|
|
13 |
<executable> assets/dna/random/dnalong.fa --amino=ser --min=0 --max=100 |
|
|
14 |
``` |
|
|
15 |
|
|
|
16 |
Help message (--help): |
|
|
17 |
|
|
|
18 |
``` |
|
|
19 |
Usage: DNAnalyzer [-hrV] --amino=<aminoAcid> [--find=<proteinFile>] |
|
|
20 |
[--max=<maxCount>] [--min=<minCount>] DNA |
|
|
21 |
A program to analyze DNA sequences. |
|
|
22 |
DNA The FASTA file to be analyzed. |
|
|
23 |
--amino=<aminoAcid> The amino acid representing the start of a gene. |
|
|
24 |
--find=<proteinFile> The DNA sequence to be found within the FASTA file. |
|
|
25 |
-h, --help Show this help message and exit. |
|
|
26 |
--max=<maxCount> The maximum count of the reading frame. |
|
|
27 |
--min=<minCount> The minimum count of the reading frame. |
|
|
28 |
-r, --reverse Reverse the DNA sequence before processing. |
|
|
29 |
-V, --version Print version information and exit. |
|
|
30 |
``` |