Skip to content

Commit

Permalink
Update documentation in README.md and arcs-make (#160)
Browse files Browse the repository at this point in the history
- Noting that when running Tigmint in a pipeline, the input files must be in your current working directory
  • Loading branch information
lcoombe authored Apr 14, 2023
1 parent 50f1cf2 commit ebbf24b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ The ARCS+LINKS pipeline requires two input files:
* Reads file in fastq format `*.fq.gz` (or fasta format `*.fa.gz` if using long reads)
* For linked reads, ARCS expects an interleaved linked reads file (Barcode sequence expected in the BX tag of the read header or in the form "@readname_barcode" ; Run [Long Ranger basic](https://support.10xgenomics.com/genome-exome/software/pipelines/latest/what-is-long-ranger) on raw chromium reads to produce this interleaved file)

The Makefile located here: bin/arcs-make will run the full ARCS pipeline. It will also optionally run the misassembly corrector [Tigmint](https://github.com/bcgsc/tigmint) prior to scaffolding with ARCS.
The Makefile located here: bin/arcs-make will run the full ARCS pipeline. It will also optionally run the misassembly corrector [Tigmint](https://github.com/bcgsc/tigmint) prior to scaffolding with ARCS. If you are running Tigmint in your pipeline, please ensure that all input files are in your current working directory.

There are three steps to the pipeline:

Expand Down
1 change: 1 addition & 0 deletions bin/arcs-make
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ help:
@echo "Example: To run tigmint and arcs with myDraft.fa, myReads.fq.gz, and a custom multiplicty range, run:"
@echo " ./arcs-make arcs-tigmint draft=myDraft reads=myReads m=[User defined multiplicty range]"
@echo "To ensure that the pipeline runs correctly, make sure that the following tools are in your PATH: bwa, tigmint, samtools, arcs (>= v1.1.0), LINKS (>= v1.8.6)"
@echo "When running targets including Tigmint, please ensure that all input files are in your current working directory."

clean:
rm -f *.amb *.ann *.bwt *.pac *.sa *.dist.gv *.fai *.bed *.molecule.tsv *.sortbx.bam
Expand Down

0 comments on commit ebbf24b

Please sign in to comment.