Skip to content

Commit

Permalink
Add citation
Browse files Browse the repository at this point in the history
  • Loading branch information
johnlees committed Oct 29, 2024
1 parent a2b973d commit fa2a99b
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 4 deletions.
49 changes: 49 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
cff-version: 1.2.0
message: If you use this software, please cite both the article from preferred-citation and the software itself.
authors:
- family-names: Derelle
given-names: Romain
- family-names: von Wachsmann
given-names: Johanna
- family-names: Mäklin
given-names: Tommi
- family-names: Croucher
given-names: Nicholas J.
- family-names: Harris
given-names: Simon R.
- family-names: Lees
given-names: John A.
title: Split K-mer Analysis (version 2)
version: 0.3.11
url: https://github.com/bacpop/ska.rust
date-released: '2024-09-25'
preferred-citation:
authors:
- family-names: Derelle
given-names: Romain
- family-names: von Wachsmann
given-names: Johanna
- family-names: Mäklin
given-names: Tommi
- family-names: Hellewell
given-names: Joel
- family-names: Russell
given-names: Timothy
- family-names: Lalvani
given-names: Ajit
- family-names: Chindelevitch
given-names: Leonid
- family-names: Croucher
given-names: Nicholas J.
- family-names: Harris
given-names: Simon R.
- family-names: Lees
given-names: John A.
title: Seamless, rapid, and accurate analyses of outbreak genomic data using split k-mer analysis
doi: 10.1101/gr.279449.124
url: http://genome.cshlp.org/content/34/10/1661.abstract
type: article-journal
pages: 1661-1673
year: '2024'
conference: {}
publisher: {}
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ SKA can only align SNPs further than the k-mer length apart, and does not use a

### Citation

Romain Derelle, Johanna von Wachsmann, Tommi Mäklin, Joel Hellewell, Timothy Russell, Ajit Lalvani, Leonid Chindelevitch, Nicholas J. Croucher, Simon R. Harris, John A. Lees (2024).
**Seamless, rapid and accurate analyses of outbreak genomic data using Split _k_-mer Analysis**
*Genome Research*
Romain Derelle, Johanna von Wachsmann, Tommi Mäklin, Joel Hellewell, Timothy Russell, Ajit Lalvani, Leonid Chindelevitch, Nicholas J. Croucher, Simon R. Harris, John A. Lees (2024). Seamless, rapid, and accurate analyses of outbreak genomic data using split k-mer analysis. Genome Research, 34(10), 1661–1673.

https://genome.cshlp.org/content/34/10/1661.abstract

## Documentation

Expand Down
6 changes: 5 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Split k-mer analysis (version 2) uses exact matching of split k-mer sequences to align closely related
//! Split k-mer analysis (version 2) uses exact matching of split k-mer sequences to align closely related
//! sequences, typically small haploid genomes such as bacteria and viruses.
//!
//! SKA can only align SNPs further than the k-mer length apart,
Expand Down Expand Up @@ -37,6 +37,10 @@
//! - [From genomes to trees](https://www.bacpop.org/guides/building_trees_with_ska/).
//! - [Filtering options](https://www.bacpop.org/guides/snp_alignment_with_ska/).
//!
//! Papers:
//! - [Seamless, rapid, and accurate analyses of outbreak genomic data using split k-mer analysis ](https://genome.cshlp.org/content/34/10/1661.abstract).
//! - [skalo: using SKA split k-mers with coloured de Brujin graphs to genotype indels](https://www.biorxiv.org/content/10.1101/2024.10.02.616334v1).
//!
//! Command line usage follows. For API documentation and usage, see the [end of this section](#api-usage).
//!
//! # Usage
Expand Down

0 comments on commit fa2a99b

Please sign in to comment.