Skip to content

Commit aaf1a2d

Browse files
authored
Merge pull request #736 from malariagen/add-citation-info-to-dipclust-19-03-25
add citation information to dipclust docstring
2 parents 1b629c9 + aac58d6 commit aaf1a2d

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

malariagen_data/anoph/dipclust.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,11 @@ def __init__(
4444

4545
@check_types
4646
@doc(
47-
summary="Hierarchically cluster diplotypes in region and produce an interactive plot.",
47+
summary=""""
48+
Hierarchically cluster diplotypes in region and produce an interactive plot.
49+
50+
If you use this function in a publication, please cite the original manuscript: doi.org/10.1093/molbev/msae140
51+
""",
4852
)
4953
def plot_diplotype_clustering(
5054
self,
@@ -591,7 +595,11 @@ def _insert_dipclust_snp_trace(
591595
return figures, subplot_heights
592596

593597
@doc(
594-
summary="Perform diplotype clustering, annotated with heterozygosity, gene copy number and amino acid variants.",
598+
summary=""""
599+
Perform diplotype clustering, annotated with heterozygosity, gene copy number and amino acid variants.
600+
601+
If you use this function in a publication, please cite the original manuscript: doi.org/10.1093/molbev/msae140
602+
""",
595603
parameters=dict(
596604
heterozygosity="Plot heterozygosity track.",
597605
snp_transcript="Plot amino acid variants for these transcripts.",

0 commit comments

Comments
 (0)