Skip to content

Commit 932fefb

Browse files
committed
docs: fix broken DOI link in README and typos in snp_frq.py docstrings
- README.md: add missing https:// prefix to DOI citation link (#857) - snp_frq.py: fix 'varaint' -> 'variant' (2 occurrences) - snp_frq.py: fix 'accross' -> 'across' (2 occurrences) - snp_frq.py: fix 'amino acide' -> 'amino acid' - snp_frq.py: fix 'allel,' -> 'allele,'
1 parent bef737a commit 932fefb

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ modifying the `docs/source/_static/switcher.json` file accordingly.
142142

143143
If you use the `malariagen_data` package in a publication
144144
or include any of its functions or code in other materials (_e.g._ training resources),
145-
please cite: [doi.org/10.5281/zenodo.11173411](doi.org/10.5281/zenodo.11173411)
145+
please cite: [doi.org/10.5281/zenodo.11173411](https://doi.org/10.5281/zenodo.11173411)
146146

147147
Some functions may require additional citations to acknowledge specific contributions. These are indicated in the description for each relevant function.
148148

malariagen_data/anoph/snp_frq.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,15 +128,15 @@ def snp_effects(
128128
A dataframe of SNP allele frequencies, one row per variant allele. The variant alleles are indexed by
129129
their contig, their position, the reference allele, the alternate allele and the associated amino acid change.
130130
The columns are split into three categories: there is one column for each taxon filter (e.g., pass_funestus, pass_gamb_colu, ...) containing whether the site of the variant allele passes the filter;
131-
there is then 1 column for each cohort containing the frequency of the variant allele within the cohort, additionally there is a column `max_af` containing the maximum allele frequency of the variant allele accross all cohorts;
131+
there is then 1 column for each cohort containing the frequency of the variant allele within the cohort, additionally there is a column `max_af` containing the maximum allele frequency of the variant allele across all cohorts;
132132
finally, there are 9 columns describing the variant allele: `transcript` contains the gene transcript used for this analysis,
133133
`effect` is the effect of the allele change,
134134
`impact`is the impact of the allele change,
135135
`ref_codon` is the reference codon,
136136
`alt_codon` is the altered codon with the variant allele,
137137
`aa_pos` is the position of the amino acid,
138138
`ref_aa` is the reference amino acid,
139-
`alt_aa` is the altered amino acid with the varaint allele,
139+
`alt_aa` is the altered amino acid with the variant allele,
140140
and `label` is the label of the variant allele.
141141
""",
142142
notes="""
@@ -299,15 +299,15 @@ def snp_allele_frequencies(
299299
returns="""
300300
A dataframe of amino acid allele frequencies, one row per variant. The variants are indexed by
301301
their amino acid change, their contig, their position.
302-
The columns are split into two categories: there is 1 column for each cohort containing the frequency of the amino acid change within the cohort, additionally there is a column `max_af` containing the maximum frequency of the amino acide change accross all cohorts;
302+
The columns are split into two categories: there is 1 column for each cohort containing the frequency of the amino acid change within the cohort, additionally there is a column `max_af` containing the maximum frequency of the amino acid change across all cohorts;
303303
finally, there are 9 columns describing the variant allele: `transcript` contains the gene transcript used for this analysis,
304304
`effect` is the effect of the allele change,
305305
`impact`is the impact of the allele change,
306-
`ref_allele` is the reference allel,
306+
`ref_allele` is the reference allele,
307307
`alt_allele` is the alternate allele,
308308
`aa_pos` is the position of the amino acid,
309309
`ref_aa` is the reference amino acid,
310-
`alt_aa` is the altered amino acid with the varaint allele,
310+
`alt_aa` is the altered amino acid with the variant allele,
311311
and `label` is the label of the variant allele.
312312
""",
313313
notes="""

0 commit comments

Comments
 (0)