Skip to content

Commit

Permalink
more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lskatz committed Aug 7, 2023
1 parent 534d625 commit 56e0b26
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
## Prerequisite software

* Mash >= v2.0
* SQLite3
* ~~SQLite3~~ Removed in version 1.4
* Perl
* multithreading
* BioPerl library
* `DBD::SQLite`
* ~~`DBD::SQLite`~~ Removed in version 1.4
* Quicktree

### Environment
Expand All @@ -30,7 +30,7 @@ Some system packages are needed. On Ubuntu, this is how you might install these

There are some perl packages too and so this is how you would install those on most Linux OSs:

cpanm -l ~ --notest BioPerl Bio::Sketch::Mash DBD::SQLite DBI
cpanm -l ~ --notest BioPerl Bio::Sketch::Mash

#### Quicktree

Expand Down
25 changes: 24 additions & 1 deletion lib/Mashtree.pm
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,29 @@ local $0=basename $0;
Helps run a mashtree analysis to make rapid trees for genomes.
Please see github.com/lskatz/Mashtree for more information.
=over
=item mashtree executables
This document covers the Mashtree library, but the highlight
the mashtree package is the executable `mashtree`.
See github.com/lskatz/Mashtree for more information.
Fast method:
mashtree --numcpus 12 *.fastq.gz [*.fasta] > mashtree.dnd
More accurate method:
mashtree --mindepth 0 --numcpus 12 *.fastq.gz [*.fasta] > mashtree.dnd
Bootstrapping and jackknifing
mashtree_bootstrap.pl --reps 100 --numcpus 12 *.fastq.gz -- --min-depth 0 > mashtree.jackknife.dnd
mashtree_jackknife.pl --reps 100 --numcpus 12 *.fastq.gz -- --min-depth 0 > mashtree.jackknife.dnd
=back
=head1 VARIABLES
=over
Expand Down Expand Up @@ -63,7 +86,7 @@ Used to mark whether a file is being read, so that Mashtree limits disk I/O
######
# CONSTANTS

our $VERSION = "1.4.0";
our $VERSION = "1.4.1";
our $MASHTREE_VERSION=$VERSION;
our @fastqExt=qw(.fastq.gz .fastq .fq .fq.gz);
our @fastaExt=qw(.fasta .fna .faa .mfa .fas .fsa .fa);
Expand Down

0 comments on commit 56e0b26

Please sign in to comment.