-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #153 from bioinfo-chru-strasbourg/options_and_docs
Add docs #4
- Loading branch information
Showing
11 changed files
with
1,485 additions
and
199 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| <H1 id='HOWARD Configuration'>HOWARD Configuration</H1>HOWARD Configuration JSON file defined default configuration regarding resources (e.g. threads, memory), settings (e.g. verbosity, temporary files), default folders (e.g. for databases) and paths to external tools.<br> | ||
| <H2>Table of contents</H1> | ||
| - <a href='#HOWARD Configuration'>HOWARD Configuration</a><BR> - <a href='#threads'>threads</a><BR> - <a href='#memory'>memory</a><BR> - <a href='#assembly'>assembly</a><BR> - <a href='#verbosity'>verbosity</a><BR> - <a href='#tmp'>tmp</a><BR> - <a href='#access'>access</a><BR> - <a href='#duckdb_settings'>duckdb_settings</a><BR> - <a href='#chunk_size'>chunk_size</a><BR> - <a href='#log'>log</a><BR> - <a href='#folders'>folders</a><BR> - <a href='#folders::databases'>databases</a><BR> - <a href='#folders::databases::annotations'>annotations</a><BR> - <a href='#folders::databases::parquet'>parquet</a><BR> - <a href='#folders::databases::bcftools'>bcftools</a><BR> - <a href='#folders::databases::annovar'>annovar</a><BR> - <a href='#folders::databases::snpeff'>snpeff</a><BR> - <a href='#folders::databases::exomiser'>exomiser</a><BR> - <a href='#tools'>tools</a><BR> - <a href='#tools::bcftools'>bcftools</a><BR> - <a href='#tools::bgzip'>bgzip</a><BR> - <a href='#tools::snpeff'>snpeff</a><BR> - <a href='#tools::annovar'>annovar</a><BR> - <a href='#tools::exomiser'>exomiser</a><BR> - <a href='#tools::java'>java</a><BR> | ||
| <br> | ||
| <H2 id='threads'>threads</H2>Number of threads to use for processing HOWARD. It determines the level of parallelism, either on python scripts, duckDB engine and external tools. It and can help speed up the process/tool<br>Use -1 to use all available CPU/cores.<br>Default: -1<br>Examples: <br>- -1 (for all available CPU/cores)<br>- 8 (for 8 CPU/cores)<br><H2 id='memory'>memory</H2>Specify the memory to use. It determines the amount of memory for duckDB engine and external tools (especially for JAR prorams). It can help to prevent 'out of memory' failures.<br>Format: FLOAT[kMG]<br>Default: None (80% of RAM for duckDB)<br>Examples: <br>- 8G (for 8Go of memory)<br>- 1024M (for 1Go of memory)<br>- 24.8G (for 24Go and 800Mo of memory)<br><H2 id='assembly'>assembly</H2>Default assembly. This parameter will by overwritten in the paramter JSON file.<br>Default: hg19<br>Examples: <br>- "hg19" (for Homo Sapiens hg19/GRCh37 assembly)<br>- "hg38" (for Homo Sapiens hg38/GRCh38 assembly)<br>- "ailMel1.99" (for Giant Panda assembly)<br><H2 id='verbosity'>verbosity</H2>Verbosity level, such as:<br>- DEBUG: Detailed information, typically of interest only when diagnosing problems.<br>- INFO: Confirmation that things are working as expected.<br>- WARNING: An indication that something unexpected happened, or indicative of some problem in the near future (e.g. ‘disk space low’). The software is still working as expected.<br>- ERROR: Due to a more serious problem, the software has not been able to perform some function.<br>- CRITICAL: A serious error, indicating that the program itself may be unable to continue running.<br>- NOTSET: All messages.<br>Default: INFO<br>Examples: CRITICAL, ERROR, WARNING, INFO, DEBUG or NOTSET<br><H2 id='tmp'>tmp</H2>Temporary folder, espacially for duckDB (see doc), external tools and python scripts.<br>Format: Path<br>Default: None<br>Examples: <br>- /tmp<br>- .tmp<br><H2 id='access'>access</H2>Access mode to variants file or database.Either 'RW' for Read and Write, or 'RO' for Read Only.<br>Format: either 'RO' or 'RW'<br>Default: RW<br>Examples: <br>- RO<br>- RW<br><H2 id='duckdb_settings'>duckdb_settings</H2>DuckDB settings (see duckDB doc) as JSON (string or file). These settings have priority (see options 'threads', 'tmp'...).<br>Default: {}<br>Examples: <br>- {"TimeZone": "GMT", "temp_directory": "/tmp/duckdb", "threads": 8}<br>- /path/to/duckdb_config.json<br><H2 id='chunk_size'>chunk_size</H2>Number of records in batch to export output file. The lower the chunk size, the less memory consumption. For Parquet partitioning, files size will depend on the chunk size.<br>Default: 1000000<br>Examples: <br>- 1000000<br>- 100000<br><H2 id='log'>log</H2>Log file.<br>Default: None<br>Examples: <br>- my.log<br>- /tmp/my.log<br><H2 id='folders'>folders</H2>Configuration for folders such as databases<br><H3 id='folders::databases'>folders::databases</H3>Default folders for databases that follows the specific database HOWARD format. These folders will be used in HOWARD tools to autodetect databases by their name and using assembly.<br>Format: /path/to/databases/db_name/db_release/assembly/database_file<br><H4 id='folders::databases::annotations'>folders::databases::annotations</H4>Annotation databases folders that contains databases in various format such as Parquet, VCF, duckDB and TSV.<br>Format: a list of folder path (without assembly)<br>Default: ["/databases/annotations/current"]<br>Examples: <br>- ["/databases/annotations/current/"]<br>- ["/databases/annotations/current/","/databases/dejavu/current/","/databases/dbnsfp/current/"]<br><H4 id='folders::databases::parquet'>folders::databases::parquet</H4>Annotation databases folders that contains databases in Parquet format.<br>Format: a list of folder path (without assembly)<br>Default: ["/databases/annotations/current"]<br>Examples: <br>- ["/databases/parquet/current/"]<br>- ["/databases/annotations/current/"]<br>- ["/databases/parquet/current/","/databases/dejavu/current/"]<br><H4 id='folders::databases::bcftools'>folders::databases::bcftools</H4>Annotation databases folders for BCFTools annotation.<br>Format: a list of folder path (without assembly)<br>Default: ["/databases/bcftools/current"]<br>Examples: <br>- ["/databases/bcftools/current/"]<br>- ["/databases/bcftools/current/","/databases/dejavu/current/"]<br><H4 id='folders::databases::annovar'>folders::databases::annovar</H4>Annotation databases folders for Annovar annotation.<br>Format: a list of folder path (without assembly)<br>Default: ["/databases/annovar/current"]<br>Examples: <br>- ["/databases/annovar/current/"]<br>- ["/databases/annovar/current/","/databases/annovar/homemade/"]<br><H4 id='folders::databases::snpeff'>folders::databases::snpeff</H4>Annotation databases folders for snpEff annotation.<br>Format: A folder path (without assembly)<br>Default: /databases/snpeff/current<br>Examples: <br>- "/databases/snpeff/current/"<br><H4 id='folders::databases::exomiser'>folders::databases::exomiser</H4>Annotation databases folders for Exomiser annotation.<br>Format: A folder path (without assembly)<br>Default: /databases/exomiser/current<br>Examples: <br>- "/databases/exomiser/current/"<br><H2 id='tools'>tools</H2>External tools paths that can be defined as path to a binary or a dict including the binary type (such as "bin", "jar", "perl").<br>Examples: <br>- "/path/to/tool/bin/tool.bin"<br>- {"bin": "/path/to_tool/bin/tool.sh"}<br>- {"bin": "/path/to_tool/bin/java"}, {"perl": "/path/to_tool/bin/tool.pl"}<br><H3 id='tools::bcftools'>tools::bcftools</H3>BCFTools binary (see https://samtools.github.io/bcftools/).<br>Default: /tools/bcftools/current/bin/bcftools<br>Examples: <br>- "/tools/bcftools/current/bin/bcftools"<br>- {"bin": "/tools/bcftools/current/bin/bcftools"}<br><H3 id='tools::bgzip'>tools::bgzip</H3>BGZip binary (see https://samtools.github.io/bcftools/).<br>Default: /tools/htslib/current/bin/bgzip<br>Examples: <br>- "/tools/htslib/current/bin/bgzip"<br>- {"bin": "/tools/htslib/current/bin/bgzip"}<br><H3 id='tools::snpeff'>tools::snpeff</H3>snpEff binary (see https://pcingola.github.io/SnpEff/).<br>Default: /tools/snpeff/current/bin/snpEff.jar<br>Examples: <br>- "/tools/snpeff/current/bin/snpEff.jar"<br>- {"jar": "/tools/snpeff/current/bin/snpEff.jar"}<br><H3 id='tools::annovar'>tools::annovar</H3>ANNOVAR perl script (see https://annovar.openbioinformatics.org/).<br>Default: /tools/annovar/current/bin/table_annovar.pl<br>Examples: <br>- "/tools/annovar/current/bin/table_annovar.pl"<br>- {"perl": "/tools/annovar/current/bin/table_annovar.pl"}<br><H3 id='tools::exomiser'>tools::exomiser</H3>Exomiser binary (see https://www.sanger.ac.uk/tool/exomiser/).<br>Default: /tools/exomiser/current/bin/exomiser-cli-13.2.0.jar<br>Examples: <br>- "/tools/exomiser/current/bin/exomiser-cli-13.2.0.jar"<br>- {"jar": "/tools/exomiser/current/bin/exomiser-cli-13.2.0.jar"}<br><H3 id='tools::java'>tools::java</H3>Java binary (see https://www.java.com).<br>Default: /tools/java/current/bin/java<br>Examples: <br>- "/tools/java/current/bin/java"<br>- "java"<br>- {"bin": "/usr/bin/java"}<br> |
Oops, something went wrong.