Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Joss editorial revision #18

Merged
merged 6 commits into from
Nov 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Binary file modified paper/benchmarks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/clean.json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/convertToFasta.json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/interleave.json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/kmer.json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/normalize.json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 3 additions & 19 deletions paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,29 +38,13 @@ There are 20 executables including but not limited to read metric generation, re

We have also taken advantage of Rust to make comprehensive and standardized documentation.
Continuous integration was implemented in GitHub Actions for unit testing, containerizing, and benchmarking.
Benchmarking was performed against other mainstream packages using `hyperfine` using 20 replicates and 2 burn-ins [@Peter_hyperfine_2023].
Benchmarking was performed against other mainstream packages using `hyperfine` using 100 replicates and 2 burn-ins [@Peter_hyperfine_2023].

## Results

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

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

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

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

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

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

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

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

![sorting fastq entries by either sequence or ID \label{fig:sort}](../tests/hyperfine/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)
![Benchmarks comparing fasten with other analagous tools. From left to right, then to bottom: Trimming with a minimum quality score; converting fastq to fasta; interleaving R1 and R2 reads; kmer counting; normalizing read depth using kmer coverage; Searching for a sequence in a fastq file; downsampling reads; sorting fastq entries by either sequence or ID; and converting nonstandard fastq files to a format whose entries are four lines each, and selecting the first 100.\label{fig:benchmarks}](benchmarks.png)

## Conclusions

Expand Down
Binary file added paper/regex.json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/sample.json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/sort.json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/straighten.json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/trim.json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Loading