bwa.yaml 4.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
{
  id: bwa,
  name: BWA (Burrows-Wheeler Alignment Tool),
  article: 10.1093/bioinformatics/btp324,
  website: "http://bio-bwa.sourceforge.net/",
  git: "https://github.com/lh3/bwa",
  description: "BWA is a software package for mapping low-divergent sequences against a large reference genome.",
  version: "0.7.17",
  documentation: "http://bio-bwa.sourceforge.net/bwa.shtml",
mmassaviol's avatar
mmassaviol committed
10
  multiqc: "custom",
11
12
13
14
15
16
17
  commands:
    [
      {
        name: bwa_index,
        command: bwa index,
        output_dir: bwa/index,
        inputs: [{ name: bwa_index_genome_fasta , file: ""}],
mmassaviol's avatar
mmassaviol committed
18
        outputs: [{ name: index, file: index, description: "Index files for bwa alignment" }],
19
20
        options:
          [
21
22
23
24
25
26
            {
              name: bwa_index_path,
              type: input_dir,
              value: "",
              label: "Path to an existing bwa index (or where to save a new one)",
            },
27
28
            {
              name: bwa_index_genome_fasta,
29
30
              type: input_file,
              accept: [".fasta",".fa",".fasta.gz",".fa.gz"],
31
              value: "",
32
              multiple: FALSE,
mmassaviol's avatar
mmassaviol committed
33
              label: "Path to reference genome fasta file",
34
35
36
37
38
39
40
41
42
43
44
45
46
            },
            {
              name: "bwa_index_algorithm",
              type: "radio",
              value: "bwtsw",
              choices: [bwtsw: bwtsw, is: is],
              label: "Algorithm for constructing BWT index (see documentation for details)",
            }
          ]
      },
      {
        name: bwa_mem_PE,
        command: bwa mem,
mmassaviol's avatar
mmassaviol committed
47
        output_dir: bwa/mem/PE,
48
        inputs: [{ name: reads }, { name: index, file: bwa/index/index }],
mmassaviol's avatar
mmassaviol committed
49
        outputs: [{ name: bam, file: "{sample}.bam", description: "Alignment files" }],
50
51
52
53
54
55
56
57
58
59
60
        options:
          [
            {
              name: bwa_mem_threads,
              prefix: -t,
              type: numeric,
              value: 4,
              min: 1,
              max: NA,
              step: 1,
              label: "Number of threads to use",
61
62
63
64
65
66
67
            },
            {
              name: bwa_mem_quality0_multimapping,
              prefix: ,
              type: checkbox,
              value: TRUE,
              label: "Put 0 as mapping quality for multimapping reads",
68
69
70
71
72
73
            }
          ]
      },
      {
        name: bwa_mem_SE,
        command: bwa mem,
mmassaviol's avatar
mmassaviol committed
74
        output_dir: bwa/mem/SE,
75
        inputs: [{ name: reads }, { name: index, file: bwa/index/index }],
mmassaviol's avatar
mmassaviol committed
76
        outputs: [{ name: bam, file: "{sample}.bam", description: "Alignment files" }],
77
78
79
80
81
82
83
84
85
86
87
        options:
          [
            {
              name: bwa_mem_threads,
              prefix: -t,
              type: numeric,
              value: 4,
              min: 1,
              max: NA,
              step: 1,
              label: "Number of threads to use",
88
89
90
91
92
93
94
            },
            {
              name: bwa_mem_quality0_multimapping,
              prefix: ,
              type: checkbox,
              value: TRUE,
              label: "Put 0 as mapping quality for multimapping reads",
95
96
97
98
99
            }
          ]
      }
    ],
  install:  {
100
    bwa: [
101
      "cd /opt/biotools",
mmassaviol's avatar
mmassaviol committed
102
      "wget https://github.com/lh3/bwa/releases/download/v0.7.17/bwa-0.7.17.tar.bz2",
103
104
      "tar -xvjf bwa-0.7.17.tar.bz2",
      "cd bwa-0.7.17",
mmassaviol's avatar
mmassaviol committed
105
      "make -j 10",
106
107
108
      "mv bwa ../bin/",
      "cd ..",
      "rm -r bwa-0.7.17 bwa-0.7.17.tar.bz2"
109
110
111
    ],
    samtools: [
      "cd /opt/biotools",
mmassaviol's avatar
mmassaviol committed
112
      "wget https://github.com/samtools/samtools/releases/download/1.9/samtools-1.9.tar.bz2",
113
114
115
116
117
118
119
      "tar -xvjf samtools-1.9.tar.bz2",
      "cd samtools-1.9",
      "./configure && make",
      "cd ..",
      "mv samtools-1.9/samtools bin/samtools",
      "rm -r samtools-1.9 samtools-1.9.tar.bz2"
    ]
120
  },
mmassaviol's avatar
mmassaviol committed
121
122
123
124
125
126
127
128
129
130
131
  citations: [
    bwa: [
      "Heng Li, Richard Durbin, Fast and accurate short read alignment with Burrows–Wheeler transform, Bioinformatics, Volume 25, Issue 14, 15 July 2009, Pages 1754–1760, https://doi.org/10.1093/bioinformatics/btp324"
    ],
    bwa-mem: [
      "Li H. (2013) Aligning sequence reads, clone sequences and assembly contigs with BWA-MEM. arXiv:1303.3997v1 [q-bio.GN]"
    ],
    samtools: [
      "Heng Li, Bob Handsaker, Alec Wysoker, Tim Fennell, Jue Ruan, Nils Homer, Gabor Marth, Goncalo Abecasis, Richard Durbin, 1000 Genome Project Data Processing Subgroup, The Sequence Alignment/Map format and SAMtools, Bioinformatics, Volume 25, Issue 16, 15 August 2009, Pages 2078–2079, https://doi.org/10.1093/bioinformatics/btp352"
    ]
  ]
132
}