Skip to content

Commit

Permalink
Update index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tovahmarkowitz committed Mar 13, 2024
1 parent 90988e4 commit 26750ca
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<h1 style="font-size: 250%">HiIP 🔬</h1>

<b><i>long pipeline name</i></b><br>
<b><i>Restriction enzyme free HiChIP</i></b><br>
<a href="https://github.com/OpenOmics/HiIP/actions/workflows/main.yaml">
<img alt="tests" src="https://github.com/OpenOmics/HiIP/workflows/tests/badge.svg">
</a>
Expand All @@ -17,14 +17,14 @@
</a>

<p>
This is the home of the pipeline, HiIP. Its long-term goals: to accurately ...insert goal, to infer ...insert goal, and to boldly ...insert goal like no pipeline before!
This is the home of the pipeline, HiIP. Its long-term goals: to accurately align restriction enzyme free (DNAse/MNase digested) HiChIP data, create contact maps, and to boldly identify loops and TADs like no pipeline before!
</p>

</div>


## Overview
Welcome to HiIP's documentation! This guide is the main source of documentation for users that are getting started with the [long pipeline name](https://github.com/OpenOmics/HiIP/).
Welcome to HiIP's documentation! This guide is the main source of documentation for users that are getting started with the [Restriction enzyme free HiChIP](https://github.com/OpenOmics/HiIP/).

The **`./HiIP`** 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:

Expand Down Expand Up @@ -58,7 +58,7 @@ The **`./HiIP`** pipeline is composed several inter-related sub commands to setu

</section>

**HiIP** is a comprehensive ...insert long description. It relies on technologies like [Singularity<sup>1</sup>](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 [Snakemake<sup>2</sup>](https://snakemake.readthedocs.io/en/stable/), a flexible and scalable workflow management system, to submit jobs to a cluster.
**HiIP** is a comprehensive pipeline to process restriction enzyme free (DNAse/MNase digested) HiChIP data. It relies on technologies like [Singularity<sup>1</sup>](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 [Snakemake<sup>2</sup>](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 or on-premise using a cluster. 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.

Expand Down

0 comments on commit 26750ca

Please sign in to comment.