Skip to content

Commit

Permalink
Update 'dnabc.py' to 'dnabc' in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ulthran committed Jun 25, 2024
1 parent 09e4dfb commit 3cf4b95
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
Expand Up @@ -15,24 +15,24 @@ Identify DNA barcodes in FASTQ data files and write demultiplexed data.
git clone https://github.com/PennChopMicrobiomeProgram/dnabc.git
cd dnabc
pip install .
dnabc.py -h
dnabc -h
```

### DockerHub

```bash
docker pull ctbushman/dnabc:latest
docker run --rm --name dnabc dnabc dnabc.py -h
docker run --rm --name dnabc dnabc dnabc -h
```

## Usage

The Python library provides a command-line program, `dnabc.py`. The
The Python library provides a command-line program, `dnabc`. The
program takes three positional arguments: a file of barcodes, a FASTQ
file of forward reads, and a FASTQ file of reverse reads.

```bash
dnabc.py barcodes.txt myreads_R1.fastq myreads_R2.fastq
dnabc barcodes.txt myreads_R1.fastq myreads_R2.fastq
```

The FASTQ files can be compressed with `gzip`, and are treated as
Expand Down

0 comments on commit 3cf4b95

Please sign in to comment.