Skip to content

Commit 4b092ea

Browse files
committed
fixy and cosmetics
1 parent 72842fb commit 4b092ea

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

anvio/docs/programs/anvi-gen-variability-profile.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11

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).
33

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.
55

6-
## Let's talk parameters
6+
## Let's talk parameters
77

8-
Here is a basic run with no bells or whisles:
8+
Here is a basic run with no bells or whisles:
99

1010
{{ codestart }}
1111
anvi-gen-variability-profile -p %(profile-db)s \
12-
-c %(contigs-db)s \
12+
-c %(contigs-db)s \
1313
-C DEFAULT \
1414
-b EVERYTHING
1515
{{ codestop }}
1616

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.
1818

19-
You can add structural annotations by providing a %(structure-db)s.
19+
You can add structural annotations by providing a %(structure-db)s.
2020

2121
{{ codestart }}
2222
anvi-gen-variability-profile -p %(profile-db)s \
2323
-c %(contigs-db)s \
2424
-C DEFAULT \
2525
-b EVERYTHING \
26-
-s %(structure-db)s
26+
-s %(structure-db)s
2727
{{ codestop }}
2828

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.
3030

3131
{{ codestart }}
3232
anvi-gen-variability-profile -p %(profile-db)s \
@@ -36,9 +36,9 @@ anvi-gen-variability-profile -p %(profile-db)s \
3636
--output-file /path/to/your/variability.txt
3737
{{ codestop }}
3838

39-
### Focusing on a subset of the input
39+
### Focusing on a subset of the input
4040

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:
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:
4242

4343
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`)
4444

@@ -48,26 +48,26 @@ Instead of focusing on everything (providing the collection `DEFAULT` and the bi
4848
--gene-caller-ids 1,2,3
4949
{{ codestop }}
5050

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.
5252

5353
{{ codestart }}
5454
anvi-gen-variability-profile -p %(profile-db)s \
5555
-c %(contigs-db)s \
5656
--splits-of-intest %(splits-txt)s
5757
{{ codestop }}
58-
59-
3. Provide some other %(collection)s and %(bin)s.
58+
59+
3. Provide some other %(collection)s and %(bin)s.
6060

6161
{{ codestart }}
6262
anvi-gen-variability-profile -p %(profile-db)s \
63-
-c %(contigs-db)s \
63+
-c %(contigs-db)s \
6464
-C %(collection)s \
6565
-b %(bin)s
6666
{{ codestop }}
6767

68-
### Additional ways to focus the input
68+
### Additional ways to focus the input
6969

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.
7171

7272
{{ codestart }}
7373
anvi-gen-variability-profile -p %(profile-db)s \
@@ -95,7 +95,7 @@ DAY_22A
9595
...
9696
{{ codestop }}
9797

98-
### SNVs vs. SCVs vs. SAAVs
98+
### SNVs vs. SCVs vs. SAAVs
9999

100100
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.
101101

@@ -119,7 +119,7 @@ anvi-gen-variability-profile -p %(profile-db)s \
119119
--engine CDN
120120
{{ codestop }}
121121

122-
### Filtering the output
122+
### Filtering the output
123123

124124
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:
125125

@@ -130,7 +130,7 @@ You can filter the output in various ways, so that you can get straight to the v
130130

131131
### --quince-mode
132132

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.
134134

135135
### --kiefl-mode
136136

0 commit comments

Comments
 (0)