Files
biobox/target/executable/samtools/samtools_faidx/.config.vsh.yaml
CI db2f4203b8 Build branch main with version main (c3ba4a7)
Build pipeline: viash-hub.biobox.main-n2mwd

Source commit: c3ba4a7849

Source message: Bcftools annotate (#143)

* Initial commit

* Update config.vsh.yaml

* changes in config file

* Update script.sh

* Help File

* Update script.sh

* Update test.sh

* bug fixing and adding tests

* Update test.sh

* Update test.sh

* adding 3rd test

* More tests

* Moreee tests

* Update test.sh

* small changes

* Update CHANGELOG.md

* Update config.vsh.yaml

* bug fixing on config

* Requested changes

---------

Co-authored-by: Jakub Majercik <57993790+jakubmajercik@users.noreply.github.com>
2024-09-10 14:11:21 +00:00

270 lines
7.3 KiB
YAML

name: "samtools_faidx"
namespace: "samtools"
version: "main"
authors:
- name: "Emma Rousseau"
roles:
- "author"
- "maintainer"
info:
links:
email: "emma@data-intuitive.com"
github: "emmarousseau"
linkedin: "emmarousseau1"
organizations:
- name: "Data Intuitive"
href: "https://www.data-intuitive.com"
role: "Bioinformatician"
argument_groups:
- name: "Inputs"
arguments:
- type: "file"
name: "--input"
description: "FASTA input file.\n"
info: null
must_exist: true
create_parent: true
required: false
direction: "input"
multiple: false
multiple_sep: ";"
- type: "integer"
name: "--length"
alternatives:
- "-n"
description: "Length for FASTA sequence line wrapping. If zero, this means do\
\ not\nline wrap. Defaults to the line length in the input file.\n"
info: null
default:
- 60
required: false
direction: "input"
multiple: false
multiple_sep: ";"
- type: "file"
name: "--region_file"
alternatives:
- "-r"
description: "File of regions. Format is chr:from-to. One per line.\nMust be used\
\ with --output to avoid sending output to stdout.\n"
info: null
must_exist: true
create_parent: true
required: false
direction: "input"
multiple: false
multiple_sep: ";"
- name: "Options"
arguments:
- type: "boolean_true"
name: "--continue"
description: "Continue working if a non-existent region is requested.\n"
info: null
direction: "input"
- type: "boolean_true"
name: "--reverse_complement"
alternatives:
- "-i"
description: "Reverse complement sequences.\n"
info: null
direction: "input"
- name: "Outputs"
arguments:
- type: "file"
name: "--output"
alternatives:
- "-o"
description: "Write output to file.\n"
info: null
example:
- "output.fasta"
must_exist: true
create_parent: true
required: true
direction: "output"
multiple: false
multiple_sep: ";"
- type: "string"
name: "--mark_strand"
description: "Add strand indicator to sequence name. Options are:\n[ rc, no, sign,\
\ custom,<pos>,<neg> ]\n"
info: null
default:
- "rc"
required: false
direction: "input"
multiple: false
multiple_sep: ";"
- type: "file"
name: "--fai_idx"
description: "Read/Write to specified index file (default file.fa.fai).\n"
info: null
example:
- "file.fa.fai"
must_exist: true
create_parent: true
required: false
direction: "output"
multiple: false
multiple_sep: ";"
- type: "file"
name: "--gzi_idx"
description: "Read/Write to specified compressed file index (used with .gz files,\
\ default file.fa.gz.gzi).\n"
info: null
example:
- "file.fa.gz.gzi"
must_exist: true
create_parent: true
required: false
direction: "output"
multiple: false
multiple_sep: ";"
- type: "boolean_true"
name: "--fastq"
description: "Read FASTQ files and output extracted sequences in FASTQ format.\
\ Same as using samtools fqidx.\n"
info: null
direction: "input"
resources:
- type: "bash_script"
path: "script.sh"
is_executable: true
description: "Indexes FASTA files to enable random access to fasta and fastq files."
test_resources:
- type: "bash_script"
path: "test.sh"
is_executable: true
- type: "file"
path: "test_data"
info: null
status: "enabled"
requirements:
commands:
- "ps"
keywords:
- "idex"
- "fasta"
- "faidx"
license: "MIT/Expat"
references:
doi:
- "10.1093/bioinformatics/btp352"
- "10.1093/gigascience/giab008"
links:
repository: "https://github.com/samtools/samtools"
homepage: "https://www.htslib.org/"
documentation: "https://www.htslib.org/doc/samtools-faidx.html"
runners:
- type: "executable"
id: "executable"
docker_setup_strategy: "ifneedbepullelsecachedbuild"
- type: "nextflow"
id: "nextflow"
directives:
tag: "$id"
auto:
simplifyInput: true
simplifyOutput: false
transcript: false
publish: false
config:
labels:
mem1gb: "memory = 1000000000.B"
mem2gb: "memory = 2000000000.B"
mem5gb: "memory = 5000000000.B"
mem10gb: "memory = 10000000000.B"
mem20gb: "memory = 20000000000.B"
mem50gb: "memory = 50000000000.B"
mem100gb: "memory = 100000000000.B"
mem200gb: "memory = 200000000000.B"
mem500gb: "memory = 500000000000.B"
mem1tb: "memory = 1000000000000.B"
mem2tb: "memory = 2000000000000.B"
mem5tb: "memory = 5000000000000.B"
mem10tb: "memory = 10000000000000.B"
mem20tb: "memory = 20000000000000.B"
mem50tb: "memory = 50000000000000.B"
mem100tb: "memory = 100000000000000.B"
mem200tb: "memory = 200000000000000.B"
mem500tb: "memory = 500000000000000.B"
mem1gib: "memory = 1073741824.B"
mem2gib: "memory = 2147483648.B"
mem4gib: "memory = 4294967296.B"
mem8gib: "memory = 8589934592.B"
mem16gib: "memory = 17179869184.B"
mem32gib: "memory = 34359738368.B"
mem64gib: "memory = 68719476736.B"
mem128gib: "memory = 137438953472.B"
mem256gib: "memory = 274877906944.B"
mem512gib: "memory = 549755813888.B"
mem1tib: "memory = 1099511627776.B"
mem2tib: "memory = 2199023255552.B"
mem4tib: "memory = 4398046511104.B"
mem8tib: "memory = 8796093022208.B"
mem16tib: "memory = 17592186044416.B"
mem32tib: "memory = 35184372088832.B"
mem64tib: "memory = 70368744177664.B"
mem128tib: "memory = 140737488355328.B"
mem256tib: "memory = 281474976710656.B"
mem512tib: "memory = 562949953421312.B"
cpu1: "cpus = 1"
cpu2: "cpus = 2"
cpu5: "cpus = 5"
cpu10: "cpus = 10"
cpu20: "cpus = 20"
cpu50: "cpus = 50"
cpu100: "cpus = 100"
cpu200: "cpus = 200"
cpu500: "cpus = 500"
cpu1000: "cpus = 1000"
debug: false
container: "docker"
engines:
- type: "docker"
id: "docker"
image: "quay.io/biocontainers/samtools:1.19.2--h50ea8bc_1"
target_registry: "images.viash-hub.com"
target_tag: "main"
namespace_separator: "/"
setup:
- type: "docker"
run:
- "samtools --version 2>&1 | grep -E '^(samtools|Using htslib)' | \\\nsed 's#Using\
\ ##;s# \\([0-9\\.]*\\)$#: \\1#' > /var/software_versions.txt\n"
entrypoint: []
cmd: null
- type: "native"
id: "native"
build_info:
config: "src/samtools/samtools_faidx/config.vsh.yaml"
runner: "executable"
engine: "docker|native"
output: "target/executable/samtools/samtools_faidx"
executable: "target/executable/samtools/samtools_faidx/samtools_faidx"
viash_version: "0.9.0-RC7"
git_commit: "c3ba4a78497f7518725bb7d3e213b2a9bcee511e"
git_remote: "https://github.com/viash-hub/biobox"
package_config:
name: "biobox"
version: "main"
description: "A collection of bioinformatics tools for working with sequence data.\n"
info: null
viash_version: "0.9.0-RC7"
source: "src"
target: "target"
config_mods:
- ".requirements.commands := ['ps']\n"
- ".engines += { type: \"native\" }"
- ".engines[.type == 'docker'].target_registry := 'images.viash-hub.com'"
- ".engines[.type == 'docker'].target_tag := 'main'"
keywords:
- "bioinformatics"
- "modules"
- "sequencing"
license: "MIT"
organization: "vsh"
links:
repository: "https://github.com/viash-hub/biobox"
issue_tracker: "https://github.com/viash-hub/biobox/issues"