Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
igordot committed Feb 28, 2022
1 parent 2f777bf commit 8c8289d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 39 deletions.
1 change: 1 addition & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
title: "Seq-N-Slide"
abstract: "Automated workflows for common genomic sequencing-based protocols. Documentation is available at https://igordot.github.io/sns"
type: software
authors:
- orcid: "https://orcid.org/0000-0003-4451-126X"
Expand Down
40 changes: 1 addition & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,4 @@

Automated workflows for common sequencing-based (Illumina) protocols, such as RNA-seq, ChIP-seq, ATAC-seq, WGBS/RRBS methylation, whole genome/exome/targeted variant detection, and contaminant screening.

## Brief usage overview

Download the code.

```
git clone --depth 1 https://github.com/igordot/sns
```

Generate a sample sheet based on a directory of FASTQ files.

```
sns/gather-fastqs <fastq_dir>
```

Specify the reference genome.

```
sns/generate-settings <genome>
```

Run the analysis using a specific route.

```
sns/run <route>
```

Check if the jobs are submitted and running.

```
squeue -u $USER
```

Check for problems.

```
grep "ERROR:" logs-sbatch/*
```

For more details, check the full documentation at: https://igordot.github.io/sns
For more information, see the full documentation at https://igordot.github.io/sns

0 comments on commit 8c8289d

Please sign in to comment.