Skip to content

Commit

Permalink
adds how to cite
Browse files Browse the repository at this point in the history
  • Loading branch information
Manavalan Gajapathy committed Oct 27, 2023
1 parent 3faaa6a commit 3392460
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ In summary, QuaC performs the following:

Full documentation, including installation and how to run QuaC, is available at <https://quac.readthedocs.io>.

## Citing QuaC

If you use QuaC, please cite:

Gajapathy et al., (2023). QuaC: A Pipeline Implementing Quality Control Best Practices for Genome Sequencing and Exome Sequencing Data. Journal of Open Source Software, 8(90), 5313, https://doi.org/10.21105/joss.05313

## Repo owner

- **Mana**valan Gajapathy
Expand Down
5 changes: 5 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,8 @@ from it's last state.
* If `--cli_cluster_config` was used, logs from the snakemake process are stored in the directory provided using `--log_dir`. Else, logs will be directed to stderr/stdout and not stored in a file.
* If `--snakemake_cluster_config` was used, logs for the jobs triggered by snakemake workflow are stored in sub-directory `rule_logs/` under the directory provided using `--log_dir`. Else, logs will be directed to stderr/stdout.

## How to cite QuaC?

Please cite this article:

Gajapathy et al., (2023). QuaC: A Pipeline Implementing Quality Control Best Practices for Genome Sequencing and Exome Sequencing Data. Journal of Open Source Software, 8(90), 5313, https://doi.org/10.21105/joss.05313
5 changes: 5 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,8 @@ Optionally QuaC can also utilize QC results produced by the tools listed below w

* At CGDS, these optional tools were run by our small_variant_caller_pipeline.

## Citing QuaC

If you use QuaC, please cite:

Gajapathy et al., (2023). QuaC: A Pipeline Implementing Quality Control Best Practices for Genome Sequencing and Exome Sequencing Data. Journal of Open Source Software, 8(90), 5313, https://doi.org/10.21105/joss.05313

0 comments on commit 3392460

Please sign in to comment.