Skip to content

Commit

Permalink
paper figures
Browse files Browse the repository at this point in the history
  • Loading branch information
lskatz committed Nov 1, 2023
1 parent 873ccb8 commit 4283af3
Show file tree
Hide file tree
Showing 14 changed files with 25 additions and 12 deletions.
6 changes: 4 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ repository = "https://github.com/lskatz/fasten"
categories = ["command-line-utilities", "science"]
keywords = ["bioinformatics","fastq","streaming"]
readme = "./README.md"
# Docs have been copied over for the purposes of github pages
# and should not be included in the package
exclude = [
# Docs have been copied over for the purposes of github pages
# and should not be included in the package
"docs/*",
# Do not include the manuscript in the package
"paper/*",
]

[[bin]]
Expand Down
1 change: 1 addition & 0 deletions paper/clean.json.png
1 change: 1 addition & 0 deletions paper/convertToFasta.json.png
1 change: 1 addition & 0 deletions paper/interleave.json.png
1 change: 1 addition & 0 deletions paper/kmer.json.png
1 change: 1 addition & 0 deletions paper/normalize.json.png
18 changes: 9 additions & 9 deletions paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,23 +44,23 @@ Benchmarking was performed against other mainstream packages using `hyperfine` u

Documentation, the container, and code are available at GitHub. Benchmarking results were graphed into Figures \label{fig:clean} - \label{fig:straighten}.

![Trimming with a minimum quality score \label{fig:clean}](../tests/hyperfine/clean.json.png)
![Trimming with a minimum quality score \label{fig:clean}](clean.json.png)

![converting fastq to fasta \label{fig:convertToFasta}](../tests/hyperfine/convertToFasta.json.png)
![converting fastq to fasta \label{fig:convertToFasta}](convertToFasta.json.png)

![interleaving R1 and R2 reads \label{fig:interleave}](../tests/hyperfine/interleave.json.png)
![interleaving R1 and R2 reads \label{fig:interleave}](interleave.json.png)

![kmer counting \label{fig:kmer}](../tests/hyperfine/kmer.json.png)
![kmer counting \label{fig:kmer}](kmer.json.png)

![normalizing read depth using kmer coverage \label{fig:normalize}](../tests/hyperfine/normalize.json.png)
![normalizing read depth using kmer coverage \label{fig:normalize}](normalize.json.png)

![Searching for a sequence in a fastq file \label{fig:regex}](../tests/hyperfine/regex.json.png)
![Searching for a sequence in a fastq file \label{fig:regex}](regex.json.png)

![downsampling reads \label{fig:sample}](../tests/hyperfine/sample.json.png)
![downsampling reads \label{fig:sample}](sample.json.png)

![sorting fastq entries by either sequence or ID \label{fig:sort}](../tests/hyperfine/sort.json.png)
![sorting fastq entries by either sequence or ID \label{fig:sort}](sort.json.png)

![converting nonstandard fastq files to a format whose entries are four lines each, and selecting the first 100 \label{fig:straighten}](../tests/hyperfine/straighten.json.png)
![converting nonstandard fastq files to a format whose entries are four lines each, and selecting the first 100 \label{fig:straighten}](straighten.json.png)

## Conclusions

Expand Down
1 change: 1 addition & 0 deletions paper/progress.json.png
1 change: 1 addition & 0 deletions paper/regex.json.png
1 change: 1 addition & 0 deletions paper/sample.json.png
1 change: 1 addition & 0 deletions paper/sort.json.png
1 change: 1 addition & 0 deletions paper/straighten.json.png
1 change: 1 addition & 0 deletions paper/trim.json.png
2 changes: 1 addition & 1 deletion tests/lib/benchmark.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ set -u
# Hyperfine parameters
# Locally, just run a handful of times per test
# but in the cloud, boost it to ten
num_runs=20
num_runs=100
# How many times to multiply the four reads file to make a large one
multiplier=1000
if [[ ! -z ${CI+x} ]]; then
Expand Down

0 comments on commit 4283af3

Please sign in to comment.