annotate README.txt @ 4:58815aed4ec3 draft default tip

few bugfixes in VCF-2-variantlist
author saskia-hiltemann
date Wed, 04 Nov 2015 05:06:12 -0500
parents ac09a5aaed0b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
1 Installs VirtualNormal Correction Tool
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
2
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
3 After installing this tool via admin panel, manually configure the following:
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
4
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
5 1) edit virtual_normal_correction.loc file
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
6
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
7 - change "/path/to/hg18.crr" to the location of the Complete Genomics reference crr file on your system
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
8 (can be downloaded from ftp://ftp.completegenomics.com/ReferenceFiles/ )
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
9
2
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
10 - change "/path/to/VN_genomes_varfiles_lists_hg18" to the location of the directory containing files with the locations of all the Complete Genomics
0
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
11 varfiles to be used as a virtual normal. This file should contain 1 file location per line, e.g.
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
12
3
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
13 /path/to/normal-varfile-1
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
14 /path/to/normal-varfile-2
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
15 /path/to/normal-varfile-3
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
16 /path/to/normal-varfile-4
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
17 /path/to/normal-varfile-5
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
18 /path/to/normal-varfile-6
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
19 /path/to/normal-varfile-7
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
20 /path/to/normal-varfile-8
0
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
21 ...
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
22
3
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
23 - edit the tool xml file to offer one or more different sets of virtual normals:
2
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
24
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
25 [..]
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
26 <!-- edit these options to reflect sets of normal you have available. The values must name files within the directories specified in data_table_conf.xml file -->
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
27 <param name="VNset" type="select" label="Select Virtual Normal set to use" help="1000Genomes set can only be used for hg19 samples, for hg18 54 genomes will be used.">
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
28 <option value="46_diversity.txt" > CG Diversity Panel and trios (54 Genomes) </option>
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
29 <option value="433_1000g.txt" > CG 1000G project genomes (433 Genomes) (hg19 only) </option>
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
30 <option value="479_diversity_1000g.txt" > Diversity and 1000G (479 genomes) (hg19 only) </option>
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
31 <option value="10_tutorial.txt" > Small VN for tutorial (10 Genomes) </option>
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
32 </param>
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
33 [..]
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
34
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
35 the values indicate files expected to be at the location configured in the loc file,
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
36
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
37
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
38 So if your .loc file looks like this:
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
39
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
40
3
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
41 #loc file for virtual normal tool
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
42 # <columns>value, dbkey, name, VN_genomes_varfiles_lists_location, VN_genomes_junctionfile_lists_location, reference_crr_cgatools</columns>
2
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
43
3
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
44 hg18 hg18 Virtual Normal hg18 /path/to/VN_genomes_varfiles_lists_hg18/ /path/to/VN_genomes_junctionfiles_lists_hg18/ /path/to/hg18.crr
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
45 hg19 hg19 Virtual_Normal hg19 /path/to/VN_genomes_varfiles_lists_hg19/ /path/to/VN_genomes_junctionfiles_lists_hg19/ /path/to/hg19.crr
2
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
46
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
47 And your xml file like the example above, then the tool expects the following files to exist:
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
48 /path/to/VN_genomes/varfiles_list_hg18/46_diversity.txt
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
49 /path/to/VN_genomes/varfiles_list_hg18/433_1000g.txt
3
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
50 ...etc..
2
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
51
3
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
52 and each of these files must contain a 1-per-line list of locations of the varfiles of the normal genomes (or junction files in case of SV analysis).
2
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
53
885ba15c2564 Uploaded
saskia-hiltemann
parents: 0
diff changeset
54 Varfiles can be in compressed or uncompressed form. For example, Complete Genomics' Diversity panel can be used.
0
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
55 (can be downloaded from ftp://ftp2.completegenomics.com/)
3
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
56
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
57
0
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
58
3
ac09a5aaed0b Uploaded
saskia-hiltemann
parents: 2
diff changeset
59 2) restart Galaxy for changes to take effect (alternatively, in the admin panel these setting can be reloaded without the need to restart your galaxy instance)
0
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
60
1209f18a5a83 Uploaded
saskia-hiltemann
parents:
diff changeset
61 After this initial setup, additional normals can be added to the lists without having to restart Galaxy.