Skip to content

Commit

Permalink
DOC: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Vini2 committed Jul 26, 2023
1 parent 1becfe9 commit ba60cc9
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Options:
--minlength INTEGER minimum length of circular unitigs to consider
[default: 2000]
--mincov INTEGER minimum coverage of paths to output [default:
1]
10]
--compcount INTEGER maximum unitig count to consider a component
[default: 200]
--maxpaths INTEGER maximum number of paths to resolve for a
Expand All @@ -26,13 +26,18 @@ Options:
[default: 1e-10]
--seqidentity FLOAT minimum sequence identity for phrog
annotations [default: 0.3]
--covtol INTEGER coverage tolerance for extending subpaths
[default: 100]
--alpha FLOAT coverage multiplier for flow interval modelling
[default: 1.2]
--output PATH Output directory [default: phables.out]
--configfile TEXT Custom config file [default:
(outputDir)/config.yaml]
--threads INTEGER Number of threads to use [default: 1]
--use-conda / --no-use-conda Use conda for Snakemake rules [default: use-
conda]
--conda-prefix PATH Custom conda env directory
--profile TEXT Snakemake profile
--snake-default TEXT Customise Snakemake runtime args [default:
--rerun-incomplete, --printshellcmds,
--nolock, --show-failed-logs]
Expand Down Expand Up @@ -73,6 +78,8 @@ Options:
* `--mgfrac` - length threshold to consider single copy marker genes [default: 0.2]
* `--evalue` - maximum e-value for phrog annotations [default: 1e-10]
* `--seqidentity` - minimum sequence identity for phrog annotations [default: 0.3]
* `--covtol` - coverage tolerance for extending subpaths [default: 100]
* `--alpha` - coverage multiplier for flow interval modelling [default: 1.2]
* `--output` - path to the output directory [default: `phables.out`]
* `--configfile` - custom config file [default: `(outputDir)/config.yaml`]
* `--threads` - number of threads to use [default: 1]
Expand Down Expand Up @@ -131,4 +138,5 @@ The output of Phables will contain the following main files and folders.
* `resolved_genome_info.txt` containing the path name, coverage, length, GC content and unitig order of the resolved genomes
* `resolved_edges.fasta` containing the unitigs that make up the resolved genomes
* `resolved_component_info.txt` containing the details of the phage bubbles resolved
* `all_phage_like_edges.fasta` containing sequences from all the phage-like components (both resolved and unresolved)
* `all_phage_like_edges.fasta` containing sequences from all the phage-like components (both resolved and unresolved)
* `component_phrogs.txt` containing PHROGs found in each component

0 comments on commit ba60cc9

Please sign in to comment.