Skip to content

Commit 9701bcb

Browse files
authored
Removed sdag profile mentions
1 parent 1c541a1 commit 9701bcb

1 file changed

Lines changed: 39 additions & 39 deletions

File tree

docs/usage.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -930,11 +930,11 @@ can use yourself, or upload alongside your publication for others to use.
930930
To use the profile you just need to specify the file containing the profile you
931931
wish to use, and then the profile itself.
932932
933-
For example, Aida (Andrades Valtueña) on her cluster `sdag` at the MPI-SHH
934-
(`shh`) in Jena could run the following:
933+
For example, Aida (Andrades Valtueña) at the MPI-SHH (`shh`) in Jena could run
934+
the following:
935935
936936
```bash
937-
nextflow run nf-core/eager -c /<path>/<to>/AndradesValtuena2018.config -profile shh,sdag,AndradesValtuena2018 --input '/<path>/<to>/<some_input>/' <...>
937+
nextflow run nf-core/eager -c /<path>/<to>/AndradesValtuena2018.config -profile shh,AndradesValtuena2018 --input '/<path>/<to>/<some_input>/' <...>
938938
```
939939
940940
Then a colleague at a different institution, such as the SciLifeLab, could run
@@ -1026,16 +1026,16 @@ running.
10261026
```bash
10271027
nextflow run nf-core/eager \
10281028
-r 2.2.0 \
1029-
-profile singularity,shh,sdag \
1029+
-profile singularity,shh \
10301030
-name 'projectX_preprocessing20200727' \
10311031
<...>
10321032
```
10331033
10341034
For the `-profile` parameter, I have indicated that I wish to use Singularity as
10351035
my software container environment, and I will use the MPI-SHH institutional
10361036
config as listed on
1037-
[nf-core/configs](https://github.com/nf-core/configs/blob/master/conf/shh.config),
1038-
using the profile for the 'sdag' cluster. These profiles specify settings
1037+
[nf-core/configs](https://github.com/nf-core/configs/blob/master/conf/shh.config).
1038+
These profiles specify settings
10391039
optimised for the specific cluster/institution, such as maximum memory available
10401040
or which scheduler queues to submit to. More explanations about configs and
10411041
profiles can be seen in the [nf-core
@@ -1090,7 +1090,7 @@ FASTA file and the corresponding indices.
10901090
```bash
10911091
nextflow run nf-core/eager \
10921092
-r 2.2.0 \
1093-
-profile singularity,shh,sdag \
1093+
-profile singularity,shh \
10941094
-name 'projectX_preprocessing20200727' \
10951095
--input 'preprocessing20200727.tsv' \
10961096
--fasta '../Reference/genome/hs37d5.fa' \
@@ -1115,7 +1115,7 @@ directory (which contains 'intermediate' working files and directories).
11151115
```bash
11161116
nextflow run nf-core/eager \
11171117
-r 2.2.0 \
1118-
-profile singularity,shh,sdag \
1118+
-profile singularity,shh \
11191119
-name 'projectX_preprocessing20200727' \
11201120
--input 'preprocessing20200727.tsv' \`
11211121
--fasta '../Reference/genome/hs37d5.fa' \
@@ -1144,7 +1144,7 @@ string to be clipped.
11441144
```bash
11451145
nextflow run nf-core/eager \
11461146
-r 2.2.0 \
1147-
-profile singularity,shh,sdag \
1147+
-profile singularity,shh \
11481148
-name 'projectX_preprocessing20200727' \
11491149
--input 'preprocessing20200727.tsv' \
11501150
--fasta '../Reference/genome/hs37d5.fa' \
@@ -1169,7 +1169,7 @@ with `--dedupper`.
11691169
```bash
11701170
nextflow run nf-core/eager \
11711171
-r 2.2.0 \
1172-
-profile singularity,shh,sdag \
1172+
-profile singularity,shh \
11731173
-name 'projectX_preprocessing20200727' \
11741174
--input 'preprocessing20200727.tsv' \
11751175
--fasta '../Reference/genome/hs37d5.fa' \
@@ -1194,7 +1194,7 @@ and the reference.
11941194
```bash
11951195
nextflow run nf-core/eager \
11961196
-r 2.2.0 \
1197-
-profile singularity,shh,sdag \
1197+
-profile singularity,shh \
11981198
-name 'projectX_preprocessing20200727' \
11991199
--input 'preprocessing20200727.tsv' \
12001200
--fasta '../Reference/genome/hs37d5.fa' \
@@ -1221,7 +1221,7 @@ unmapped reads.
12211221
```bash
12221222
nextflow run nf-core/eager \
12231223
-r 2.2.0 \
1224-
-profile singularity,shh,sdag \
1224+
-profile singularity,shh \
12251225
-name 'projectX_preprocessing20200727' \
12261226
--input 'preprocessing20200727.tsv' \
12271227
--fasta '../Reference/genome/hs37d5.fa' \
@@ -1251,7 +1251,7 @@ fragment. We will therefore use `--bamutils_clip_half_udg_left` and
12511251
```bash
12521252
nextflow run nf-core/eager \
12531253
-r 2.2.0 \
1254-
-profile singularity,shh,sdag \
1254+
-profile singularity,shh \
12551255
-name 'projectX_preprocessing20200727' \
12561256
--input 'preprocessing20200727.tsv' \
12571257
--fasta '../Reference/genome/hs37d5.fa' \
@@ -1287,7 +1287,7 @@ you can download the file from [here](https://github.com/nf-core/test-datasets/b
12871287
```bash
12881288
nextflow run nf-core/eager \
12891289
-r 2.2.0 \
1290-
-profile singularity,shh,sdag \
1290+
-profile singularity,shh \
12911291
-name 'projectX_preprocessing20200727' \
12921292
--input 'preprocessing20200727.tsv' \
12931293
--fasta '../Reference/genome/hs37d5.fa' \
@@ -1321,7 +1321,7 @@ is simply named 'X'.
13211321
```bash
13221322
nextflow run nf-core/eager \
13231323
-r 2.2.0 \
1324-
-profile singularity,shh,sdag \
1324+
-profile singularity,shh \
13251325
-name 'projectX_preprocessing20200727' \
13261326
--input 'preprocessing20200727.tsv' \
13271327
--fasta '../Reference/genome/hs37d5.fa' \
@@ -1362,7 +1362,7 @@ providing the name of the mitochondrial DNA contig in our reference genome with
13621362
```bash
13631363
nextflow run nf-core/eager \
13641364
-r 2.2.0 \
1365-
-profile singularity,shh,sdag \
1365+
-profile singularity,shh \
13661366
-name 'projectX_preprocessing20200727' \
13671367
--input 'preprocessing20200727.tsv' \
13681368
--fasta '../Reference/genome/hs37d5.fa' \
@@ -1404,7 +1404,7 @@ file of these sites that is specified with `--pileupcaller_snpfile`.
14041404
```bash
14051405
nextflow run nf-core/eager \
14061406
-r 2.2.0 \
1407-
-profile singularity,shh,sdag \
1407+
-profile singularity,shh \
14081408
-name 'projectX_preprocessing20200727' \
14091409
--input 'preprocessing20200727.tsv' \
14101410
--fasta '../Reference/genome/hs37d5.fa' \
@@ -1646,16 +1646,16 @@ running.
16461646
```bash
16471647
nextflow run nf-core/eager \
16481648
-r 2.2.0 \
1649-
-profile singularity,shh,sdag \
1649+
-profile singularity,shh \
16501650
-name 'projectX_screening20200720' \
16511651
<...>
16521652
```
16531653
16541654
For the `-profile` parameter, I have indicated that I wish to use Singularity as
16551655
my software container environment, and I will use the MPI-SHH institutional
16561656
config as listed on
1657-
[nf-core/configs](https://github.com/nf-core/configs/blob/master/conf/shh.config),
1658-
and using the profile for the 'sdag' cluster. These profiles specify settings
1657+
[nf-core/configs](https://github.com/nf-core/configs/blob/master/conf/shh.config).
1658+
These profiles specify settings
16591659
optimised for the specific cluster/institution, such as maximum memory available
16601660
or which scheduler queues to submit to. More explanations about configs and
16611661
profiles can be seen in the [nf-core
@@ -1710,7 +1710,7 @@ FASTA file and the corresponding indices.
17101710
```bash
17111711
nextflow run nf-core/eager \
17121712
-r 2.2.0 \
1713-
-profile singularity,shh,sdag \
1713+
-profile singularity,shh \
17141714
-name 'projectX_screening20200720' \
17151715
--input 'screening20200720.tsv' \
17161716
--fasta '../Reference/genome/GRCh38.fa' \
@@ -1735,7 +1735,7 @@ directory (which contains 'intermediate' working files and directories).
17351735
```bash
17361736
nextflow run nf-core/eager \
17371737
-r 2.2.0 \
1738-
-profile singularity,shh,sdag \
1738+
-profile singularity,shh \
17391739
-name 'projectX_screening20200720' \
17401740
--input 'screening20200720.tsv' \
17411741
--fasta '../Reference/genome/GRCh38.fa' \
@@ -1764,7 +1764,7 @@ string to be clipped.
17641764
```bash
17651765
nextflow run nf-core/eager \
17661766
-r 2.2.0 \
1767-
-profile singularity,shh,sdag \
1767+
-profile singularity,shh \
17681768
-name 'projectX_screening20200720' \
17691769
--input 'screening20200720.tsv' \
17701770
--fasta '../Reference/genome/GRCh38.fa' \
@@ -1785,7 +1785,7 @@ tell nf-core/eager what to do with the off target reads from the mapping.
17851785
```bash
17861786
nextflow run nf-core/eager \
17871787
-r 2.2.0 \
1788-
-profile singularity,shh,sdag \
1788+
-profile singularity,shh \
17891789
-name 'projectX_screening20200720' \
17901790
--input 'screening20200720.tsv' \
17911791
--fasta '../Reference/genome/GRCh38.fa' \
@@ -1815,7 +1815,7 @@ documentation describing each parameters can be seen in the usage
18151815
```bash
18161816
nextflow run nf-core/eager \
18171817
-r 2.2.0 \
1818-
-profile singularity,shh,sdag \
1818+
-profile singularity,shh \
18191819
-name 'projectX_screening20200720' \
18201820
--input 'screening20200720.tsv' \
18211821
--fasta '../Reference/genome/GRCh38.fa' \
@@ -1842,7 +1842,7 @@ have indicators of true aDNA, we will run 'maltExtract' of the
18421842
```bash
18431843
nextflow run nf-core/eager \
18441844
-r 2.2.0 \
1845-
-profile singularity,shh,sdag \
1845+
-profile singularity,shh \
18461846
-name 'projectX_screening20200720' \
18471847
--input 'screening20200720.tsv' \
18481848
--fasta '../Reference/genome/GRCh38.fa' \
@@ -2113,16 +2113,16 @@ running.
21132113
```bash
21142114
nextflow run nf-core/eager \
21152115
-r 2.2.0 \
2116-
-profile singularity,shh,sdag \
2116+
-profile singularity,shh \
21172117
-name 'projectX_preprocessing20200727' \
21182118
<...>
21192119
```
21202120
21212121
For the `-profile` parameter, I have indicated that I wish to use Singularity as
21222122
my software container environment, and I will use the MPI-SHH institutional
21232123
config as listed on
2124-
[nf-core/configs](https://github.com/nf-core/configs/blob/master/conf/shh.config),
2125-
and using the profile for the 'sdag' cluster. These profiles specify settings
2124+
[nf-core/configs](https://github.com/nf-core/configs/blob/master/conf/shh.config).
2125+
These profiles specify settings
21262126
optimised for the specific cluster/institution, such as maximum memory available
21272127
or which scheduler queues to submit to. More explanations about configs and
21282128
profiles can be seen in the [nf-core
@@ -2174,7 +2174,7 @@ FASTA file and the corresponding indices.
21742174
```bash
21752175
nextflow run nf-core/eager \
21762176
-r 2.2.0 \
2177-
-profile singularity,shh,sdag \
2177+
-profile singularity,shh \
21782178
-name 'projectX_preprocessing20200727' \
21792179
--input 'preprocessing20200727.tsv' \
21802180
--fasta '../Reference/genome/Yersinia_pestis_C092_GCF_000009065.1_ASM906v1.fa' \
@@ -2199,7 +2199,7 @@ directory (which contains 'intermediate' working files and directories).
21992199
```bash
22002200
nextflow run nf-core/eager \
22012201
-r 2.2.0 \
2202-
-profile singularity,shh,sdag \
2202+
-profile singularity,shh \
22032203
-name 'projectX_preprocessing20200727' \
22042204
--input 'preprocessing20200727.tsv' \
22052205
--fasta '../Reference/genome/Yersinia_pestis_C092_GCF_000009065.1_ASM906v1.fa' \
@@ -2228,7 +2228,7 @@ the default minimum length of a poly-G string to be clipped.
22282228
```bash
22292229
nextflow run nf-core/eager \
22302230
-r 2.2.0 \
2231-
-profile singularity,shh,sdag \
2231+
-profile singularity,shh \
22322232
-name 'projectX_preprocessing20200727' \
22332233
--input 'preprocessing20200727.tsv' \
22342234
--fasta '../Reference/genome/Yersinia_pestis_C092_GCF_000009065.1_ASM906v1.fa' \
@@ -2252,7 +2252,7 @@ will do this with `--bwaalnn` and `--bwaalnl` respectively.
22522252
```bash
22532253
nextflow run nf-core/eager \
22542254
-r 2.2.0 \
2255-
-profile singularity,shh,sdag \
2255+
-profile singularity,shh \
22562256
-name 'projectX_preprocessing20200727' \
22572257
--input 'preprocessing20200727.tsv' \
22582258
--fasta '../Reference/genome/Yersinia_pestis_C092_GCF_000009065.1_ASM906v1.fa' \
@@ -2276,7 +2276,7 @@ hard-drive footprint.
22762276
```bash
22772277
nextflow run nf-core/eager \
22782278
-r 2.2.0 \
2279-
-profile singularity,shh,sdag \
2279+
-profile singularity,shh \
22802280
-name 'projectX_preprocessing20200727' \
22812281
--input 'preprocessing20200727.tsv' \
22822282
--fasta '../Reference/genome/Yersinia_pestis_C092_GCF_000009065.1_ASM906v1.fa' \
@@ -2306,7 +2306,7 @@ clarity.
23062306
```bash
23072307
nextflow run nf-core/eager \
23082308
-r 2.2.0 \
2309-
-profile singularity,shh,sdag \
2309+
-profile singularity,shh \
23102310
-name 'projectX_preprocessing20200727' \
23112311
--input 'preprocessing20200727.tsv' \
23122312
--fasta '../Reference/genome/Yersinia_pestis_C092_GCF_000009065.1_ASM906v1.fa' \
@@ -2337,7 +2337,7 @@ often a custom BED file with just genes of interest is recommended. Furthermore
23372337
```bash
23382338
nextflow run nf-core/eager \
23392339
-r 2.2.0 \
2340-
-profile singularity,shh,sdag \
2340+
-profile singularity,shh \
23412341
-name 'projectX_preprocessing20200727' \
23422342
--input 'preprocessing20200727.tsv' \
23432343
--fasta '../Reference/genome/Yersinia_pestis_C092_GCF_000009065.1_ASM906v1.fa' \
@@ -2375,7 +2375,7 @@ we do BAM trimming instead here as another demonstration of functionality.
23752375
```bash
23762376
nextflow run nf-core/eager \
23772377
-r 2.2.0 \
2378-
-profile singularity,shh,sdag \
2378+
-profile singularity,shh \
23792379
-name 'projectX_preprocessing20200727' \
23802380
--input 'preprocessing20200727.tsv' \
23812381
--fasta '../Reference/genome/Yersinia_pestis_C092_GCF_000009065.1_ASM906v1.fa' \
@@ -2416,7 +2416,7 @@ need to specify that we want to use the trimmed bams from the previous step.
24162416
```bash
24172417
nextflow run nf-core/eager \
24182418
-r 2.2.0 \
2419-
-profile singularity,shh,sdag \
2419+
-profile singularity,shh \
24202420
-name 'projectX_preprocessing20200727' \
24212421
--input 'preprocessing20200727.tsv' \
24222422
--fasta '../Reference/genome/Yersinia_pestis_C092_GCF_000009065.1_ASM906v1.fa' \
@@ -2459,7 +2459,7 @@ same settings and reference genome. We can do this as follows.
24592459
```bash
24602460
nextflow run nf-core/eager \
24612461
-r 2.2.0 \
2462-
-profile singularity,shh,sdag \
2462+
-profile singularity,shh \
24632463
-name 'projectX_preprocessing20200727' \
24642464
--input 'preprocessing20200727.tsv' \
24652465
--fasta '../Reference/genome/Yersinia_pestis_C092_GCF_000009065.1_ASM906v1.fa' \

0 commit comments

Comments
 (0)