Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/opt/bbmap-39.01-1/docs/readme_config.txt @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 68:5028fdace37b
1 BBTools Config File Readme
2 Written by Brian Bushnell
3 Last updated May 12, 2015
4
5 A config file is a text file with a set of parameters that will be added to the command line.
6 The format is one parameter per line, with the # symbol indicating comments.
7 To use a config file, use the config=file flag. For example, take BBDuk:
8
9 bbduk.sh in=reads.fq out=trimmed.fq ref=ref.fa k=23 mink=11 hdist=1 tbo tpe
10
11 That is equivalent to:
12
13 bbduk.sh in=reads.fq out=trimmed.fq ref=ref.fa config=trimadapters.txt
14 ...if trimadapters.txt contained these lines:
15 k=23
16 mink=11
17 hdist=1
18 tbo
19 tpe
20
21
22 Any parameter placed AFTER the config file will override the same parameter if it is in the config file.
23 For example, in this case k=20 will be used:
24 bbduk.sh in=reads.fq out=trimmed.fq ref=ref.fa config=trimadapters.txt k=20
25
26 But in this case, k=23 will be used, from the config file:
27 bbduk.sh in=reads.fq out=trimmed.fq ref=ref.fa k=20 config=trimadapters.txt
28
29 What are config files for? Well, mainly, to overcome difficulties like whitespace in file paths, or command lines that are too long.
30 There are some example config files in bbmap/config/. They are not used unless you specifically tell a program to use them.