Skip to content

Commit

Permalink
Removed SLURM references from README
Browse files Browse the repository at this point in the history
This package works on any batch system supported by nextflow, so it
really shouldn't spend so much time talking about SLURM.
  • Loading branch information
esrice committed Jan 15, 2021
1 parent 63853d0 commit 403c705
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# slurm-hic
A pipeline for scaffolding a genome assembly using Hi-C and SALSA2 on SLURM,
# hic-pipeline
A pipeline for scaffolding a genome assembly using Hi-C and SALSA2,
generalizable to whatever job scheduler or local system you are using. Loosely
based on the [Arima Hi-C mapping pipeline](https://github.com/ArimaGenomics/mapping_pipeline).

## Options for running
I use [nextflow](https://www.nextflow.io/) to run this pipeline, because it
automatically deals with submitting SLURM jobs and containerization. You can run
automatically deals with submitting cluster jobs and containerization. You can run
it manually too, though, or write your own scripts. There is a section below for
both of these options.

Expand Down Expand Up @@ -36,7 +36,7 @@ samtools faidx contigs.fa
Now, align the R1 and R2 reads to your contigs separately, filtering the output
through the `filter_chimeras.py` script to remove experimental artifacts from
the alignments:
```
```bash
bwa mem contigs.fa HiC-reads_R1.fastq.gz | samtools view -bh - \
| filter-chimeras.py - > r1.bam
bwa mem contigs.fa HiC-reads_R2.fastq.gz | samtools view -bh - \
Expand Down

0 comments on commit 403c705

Please sign in to comment.