From e7607ad8059a3e1a9154a38d1280e37dffeb22bf Mon Sep 17 00:00:00 2001 From: Skyler Kuhn Date: Thu, 7 Dec 2023 10:45:06 -0500 Subject: [PATCH] Chore: fixing typos, updating description and dependencies sections --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6a4d696..f6946b5 100644 --- a/README.md +++ b/README.md @@ -14,24 +14,24 @@ ## Overview Welcome to genome-seek! Before getting started, we highly recommend reading through [genome-seek's documentation](https://openomics.github.io/genome-seek/). -The **`./genome-seek`** pipeline is composed several inter-related sub commands to setup and run the pipeline across different systems. Each of the available sub commands perform different functions: +The **`./genome-seek`** pipeline is composed of several interrelated sub-commands to set up and run the pipeline across different systems. Each of the available sub-commands performs different functions: * [genome-seek run](https://openomics.github.io/genome-seek/usage/run/): Run the genome-seek pipeline with your input files. * [genome-seek unlock](https://openomics.github.io/genome-seek/usage/unlock/): Unlocks a previous runs output directory. * [genome-seek cache](https://openomics.github.io/genome-seek/usage/cache/): Cache software containers locally. -**genome-seek** is a comprehensive clinical WGS pipeline that is focused on speed. Each tool in the pipeline was benchmarked and selected due to its low run times without sacrificing accuracy or precision. It relies on technologies like [Singularity1](https://singularity.lbl.gov/) to maintain the highest-level of reproducibility. The pipeline consists of a series of data processing and quality-control steps orchestrated by [Snakemake2](https://snakemake.readthedocs.io/en/stable/), a flexible and scalable workflow management system, to submit jobs to a cluster. +**genome-seek** is a comprehensive clinical WGS pipeline that is focused on speed. Each tool in the pipeline was benchmarked and selected due to its low run times without sacrificing accuracy or precision. It relies on technologies like [Singularity1](https://singularity.lbl.gov/) to maintain the highest level of reproducibility. The pipeline consists of a series of data processing and quality-control steps orchestrated by [Snakemake2](https://snakemake.readthedocs.io/en/stable/), a flexible and scalable workflow management system, to submit jobs to a cluster. -The pipeline is compatible with data generated from Illumina short-read sequencing technologies. As input, it accepts a set of FastQ files and can be run locally on a compute instance, on-premise using a cluster, or on the cloud (feature coming soon!). A user can define the method or mode of execution. The pipeline can submit jobs to a cluster using a job scheduler like SLURM, or run on AWS using Tibanna (feature coming soon!). A hybrid approach ensures the pipeline is accessible to all users. +The pipeline is compatible with data generated from Illumina short-read sequencing technologies. As input, it accepts a set of FastQ files and can be run locally on a compute instance or on-premise using a cluster (recommended). A user can define the method or mode of execution. The pipeline can submit jobs to a cluster using a job scheduler like SLURM (more coming soon!). A hybrid approach ensures the pipeline is accessible to all users. -Before getting started, we highly recommend reading through the [usage](https://openomics.github.io/genome-seek/usage/run/) section of each available sub command. +Before getting started, we highly recommend reading through the [usage](https://openomics.github.io/genome-seek/usage/run/) section of each available sub-command. -For more information about issues or trouble-shooting a problem, please checkout our [FAQ](https://openomics.github.io/genome-seek/faq/questions/) prior to [opening an issue on Github](https://github.com/OpenOmics/genome-seek/issues). +For more information about issues or troubleshooting a problem, please check out our [FAQ](https://openomics.github.io/genome-seek/faq/questions/) before [opening an issue on Github](https://github.com/OpenOmics/genome-seek/issues). ## Dependencies **Requires:** `singularity>=3.5` `snakemake>=7.8` -At the current moment, the pipeline uses a mixture of enviroment modules and docker images; however, this will be changing soon! In the very near future, the pipeline will only use docker images. With that being said, [snakemake](https://snakemake.readthedocs.io/en/stable/getting_started/installation.html) and [singularity](https://singularity.lbl.gov/all-releases) must be installed on the target system. Snakemake orchestrates the execution of each step in the pipeline. To guarantee the highest level of reproducibility, each step of the pipeline will rely on versioned images from [DockerHub](https://hub.docker.com/orgs/nciccbr/repositories). Snakemake uses singularity to pull these images onto the local filesystem prior to job execution, and as so, snakemake and singularity will be the only two dependencies in the future. +At the current moment, the pipeline only has two dependencies: snakemake and singularity/apptainer. With that being said, [snakemake](https://snakemake.readthedocs.io/en/stable/getting_started/installation.html) and ([singularity](https://singularity.lbl.gov/all-releases) or [apptainer](https://apptainer.org/docs/admin/main/installation.html)) must be installed on the target system. Snakemake orchestrates the execution of each step in the pipeline. The second dependency, i.e singularity/apptainer, handles downloading/distribution of the pipeline's software dependencies. To guarantee the highest level of reproducibility, each step of the pipeline relies on versioned images from [DockerHub](https://hub.docker.com/repositories/skchronicles). Snakemake uses singularity to pull these images onto the local filesystem prior to job execution, and as so, snakemake and singularity/apptainer will be the only two dependencies in the future. ## Installation Please clone this repository to your local filesystem using the following command: @@ -48,7 +48,7 @@ module load snakemake singularity ``` ## Contribute -This site is a living document, created for and by members like you. genome-seek is maintained by the members of NCBR and is improved by continous feedback! We encourage you to contribute new content and make improvements to existing content via pull request to our [GitHub repository](https://github.com/OpenOmics/genome-seek). +This site is a living document, created for and by members like you. genome-seek is maintained by the members of NCBR and is improved by continuous feedback! We encourage you to contribute new content and make improvements to existing content via pull requests to our [GitHub repository](https://github.com/OpenOmics/genome-seek). ## References