Skip to content

Commit 923c50d

Browse files
author
rohan-ibn-tariq
committed
Completed meta for docs
1 parent fff0dd6 commit 923c50d

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

bio/trf/meta.yaml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,9 @@ url: https://tandem.bu.edu/trf/home
66
authors:
77
- Muhammad Rohan Ali Asmat
88
input:
9-
- fasta: A DNA sequence file in FASTA format to be analyzed by Tandem Repeats Finder.
9+
- fasta: A DNA sequence file in FASTA format to be analyzed by Tandem Repeats Finder. (Supported formats at the moment are `.fasta`, `.fna`, `.fa` and `.fas`.)
1010
output:
11-
- dat: "Data file (``*.dat``)."
12-
- mask: "Masked sequence file (``*.mask``)."
13-
- html: "HTML file (``*.html``)."
11+
- directory: This **must be specified** in the way shown in **rule** snippet above. Final contents can contain one or more of "Data file (``*.dat``), "Masked sequence file (``*.mask``) or "HTML file (``*.html``)."
1412
params:
1513
match: "Match weight (default: 2, allowed: >= 1, )"
1614
mismatch: "Mismatch penalty (default: 7, allowed: 3, 5, 7)"
@@ -27,12 +25,22 @@ notes: >
2725
2826
Flags are default to `-m -f -d`, in case the user doesn't specify a flag. Flag(s) are specified using the 'extra' param (e.g., '-d -h').
2927
In case user specifies a flag, then a flag combination with defaults is not formed rather his input of flag(s) is considered. |nl| |nl|
28+
For `-l` flag, current ways to give option value are -l29, -l 29, -l=29. |nl| |nl|
3029
31-
One or more output type of files are produced based on the flag(s) slection just as in TRF. |nl| |nl|
30+
One or more output type of files are produced based on the flag(s) selection just as in TRF. |nl| |nl|
31+
32+
If you choose `logs` directory to log in, kindly don't use this file name: **trf_run_by_logger.log**. This is reserved for logger input information.
33+
Specific to shell command, in general scenario your provided log file path will be used to log in with respective name. In case you don't provide the
34+
log file path then the content would be shown on screen and this is not recommended way. |nl| |nl|
3235
3336
For Developers: |nl|.
3437
- GitHub Repository: https://github.com/Benson-Genomics-Lab/TRF |nl|
3538
- Bioconda Package: https://prefix.dev/channels/bioconda/packages/trf |nl|
3639
40+
|nl| |nl|
41+
**Limitations & Future Work:**
42+
The wrapper has been made as flexible as possible but there is room for adding more flexibility like supporting advance typing catches `-l = 20` etc., but this has been not catered
43+
as users of this wrapper are normally those who are familiar of command line and its specificity.
44+
3745
|nl|
3846
Note: As this is a wrapper for TRF utility, it comes with it's limitations or defects if any.

0 commit comments

Comments
 (0)