You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: anvio/docs/programs/anvi-gen-variability-profile.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,32 +1,32 @@
1
1
2
-
This program takes the variability data stored within a %(profile-db)s and compiles it from across samples into a single matrix that comprehensively describes your SNVs, SCVs or SAAVs (a %(variability-profile-txt)s).
2
+
This program takes the variability data stored within a %(profile-db)s and compiles it from across samples into a single matrix that comprehensively describes your SNVs, SCVs or SAAVs (a %(variability-profile-txt)s).
3
3
4
-
This program is described on [this blog post](http://merenlab.org/2015/07/20/analyzing-variability/#the-anvio-way), so take a look at that for more details.
4
+
This program is described on [this blog post](http://merenlab.org/2015/07/20/analyzing-variability/#the-anvio-way), so take a look at that for more details.
5
5
6
-
## Let's talk parameters
6
+
## Let's talk parameters
7
7
8
-
Here is a basic run with no bells or whisles:
8
+
Here is a basic run with no bells or whisles:
9
9
10
10
{{ codestart }}
11
11
anvi-gen-variability-profile -p %(profile-db)s \
12
-
-c %(contigs-db)s \
12
+
-c %(contigs-db)s \
13
13
-C DEFAULT \
14
14
-b EVERYTHING
15
15
{{ codestop }}
16
16
17
-
Note that this program requires you to specify a subset of the databases that you want to focus on, so to focus on everything in the databases, run %(anvi-script-add-default-collection)s and use the resulting %(collection)s and %(bin)s, as shown above.
17
+
Note that this program requires you to specify a subset of the databases that you want to focus on, so to focus on everything in the databases, run %(anvi-script-add-default-collection)s and use the resulting %(collection)s and %(bin)s, as shown above.
18
18
19
-
You can add structural annotations by providing a %(structure-db)s.
19
+
You can add structural annotations by providing a %(structure-db)s.
20
20
21
21
{{ codestart }}
22
22
anvi-gen-variability-profile -p %(profile-db)s \
23
23
-c %(contigs-db)s \
24
24
-C DEFAULT \
25
25
-b EVERYTHING \
26
-
-s %(structure-db)s
26
+
-s %(structure-db)s
27
27
{{ codestop }}
28
28
29
-
You can also output your %(variability-profile-txt) to a specific location, which can be useful when working with multiple `engine` parameters.
29
+
You can also output your %(variability-profile-txt)s to a specific location, which can be useful when working with multiple `engine` parameters.
Instead of focusing on everything (providing the collection `DEFAULT` and the bin `EVERYTHING`), there are three ways to focus on a subset of the input:
41
+
Instead of focusing on everything (providing the collection `DEFAULT` and the bin `EVERYTHING`), there are three ways to focus on a subset of the input:
42
42
43
43
1. Provide a list of gene caller IDs (as a parameter with the flag `--gene-caller-ids` as shown below, or as a file with the flag `--genes-of-interest`)
44
44
@@ -48,26 +48,26 @@ Instead of focusing on everything (providing the collection `DEFAULT` and the bi
48
48
--gene-caller-ids 1,2,3
49
49
{{ codestop }}
50
50
51
-
2. Provide a %(splits-txt)s to focus only on a specific set of splits.
51
+
2. Provide a %(splits-txt)s to focus only on a specific set of splits.
52
52
53
53
{{ codestart }}
54
54
anvi-gen-variability-profile -p %(profile-db)s \
55
55
-c %(contigs-db)s \
56
56
--splits-of-intest %(splits-txt)s
57
57
{{ codestop }}
58
-
59
-
3. Provide some other %(collection)s and %(bin)s.
58
+
59
+
3. Provide some other %(collection)s and %(bin)s.
60
60
61
61
{{ codestart }}
62
62
anvi-gen-variability-profile -p %(profile-db)s \
63
-
-c %(contigs-db)s \
63
+
-c %(contigs-db)s \
64
64
-C %(collection)s \
65
65
-b %(bin)s
66
66
{{ codestop }}
67
67
68
-
### Additional ways to focus the input
68
+
### Additional ways to focus the input
69
69
70
-
When providing a %(structure-db)s, you can also limit your analysis to only genes that have structures in your database.
70
+
When providing a %(structure-db)s, you can also limit your analysis to only genes that have structures in your database.
71
71
72
72
{{ codestart }}
73
73
anvi-gen-variability-profile -p %(profile-db)s \
@@ -95,7 +95,7 @@ DAY_22A
95
95
...
96
96
{{ codestop }}
97
97
98
-
### SNVs vs. SCVs vs. SAAVs
98
+
### SNVs vs. SCVs vs. SAAVs
99
99
100
100
Which one you're analyzing depends entirely on the `engine` parameter, which you can set to `NT` (nucleotides), `CDN` (codons), or `AA` (amino acids). The default value is nucleotides. Note that to analyze SCVs or SAAVs, you'll have needed to use the flag `--profile-SCVs` when you ran %(anvi-profile)s.
You can filter the output in various ways, so that you can get straight to the variability positions that you're most interested in. Here are some of the filters that you can set:
125
125
@@ -130,7 +130,7 @@ You can filter the output in various ways, so that you can get straight to the v
130
130
131
131
### --quince-mode
132
132
133
-
You can also set `--quince-mode`, which reports the variability data across all samples for each position reported (even if that position isn't variable in some samples). For example, if nucleotide position 34 of contig 1 was a SNV in one sample, the output would contain data for nucleotide position 34 for all of your samples.
133
+
You can also set `--quince-mode`, which reports the variability data across all samples for each position reported (even if that position isn't variable in some samples). For example, if nucleotide position 34 of contig 1 was a SNV in one sample, the output would contain data for nucleotide position 34 for all of your samples.
0 commit comments