Skip to content

Commit 1b3700d

Browse files
committed
quick verbage change
1 parent 326affc commit 1b3700d

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
- [Software Dependencies](#Dependencies)
1010
- [Installation](#Installation)
1111
- [Usage Guide](#Usage)
12-
- [Contributing](#contributing)
13-
- [License](#license)
1412
- [Contact](#contact)
1513

1614

@@ -37,7 +35,8 @@ conda create --name Tiger
3735
#load your new environment
3836
conda activate Tiger
3937

40-
#install prokka. Note, prokka has a known bug with conda that you must address by editing its code base. See instructions below.
38+
# install prokka. Note, prokka has a known bug with conda that you must address by editing its code
39+
# base. See instructions below.
4140

4241
conda install -c conda-forge -c bioconda -c defaults prokka
4342

@@ -65,7 +64,9 @@ conda activate Tiger
6564
# download Tiger repository from GitHub
6665
git clone -b TIGER https://github.com/sandialabs/TIGER.git
6766

68-
# Optional: We recomend adding the path of TIGER/bin to your bash profile to avoid having to call the full program during use. We always advise making a copy of your bash profile before making any edits as a typo may have severe consequences.
67+
# Optional: We recomend adding the path of TIGER/bin to your bash profile to avoid having to call the
68+
# full program during use. We always advise making a copy of your bash profile before making any
69+
# edits as a typo may have severe consequences.
6970

7071
# ensure the execultables in the TIGER repository have executable permission on your system
7172

@@ -76,20 +77,29 @@ conda activate Tiger
7677

7778
conda install anaconda::wget
7879

79-
# get PFAM_A hmm database from NCBI: this is an OLD PFAM database (v35.0) if you want another version, you can change it in the ftp path below (note, this is the version that is suggested to use with TIGER per https://doi.org/10.3389/fbinf.2022.866850). This database must be installed to "Path to Tiger Folder"/db as PFAM-A.hmm
80+
# get PFAM_A hmm database from NCBI: this is an OLD PFAM database (v35.0) if you want another
81+
# version, you can change it in the ftp path below (note, this is the version that is suggested to
82+
# use with TIGER per https://doi.org/10.3389/fbinf.2022.866850). This database must be installed to
83+
# "Path to Tiger Folder"/db as PFAM-A.hmm
8084

8185
wget https://ftp.ebi.ac.uk/pub/databases/Pfam/releases/Pfam35.0/Pfam-A.hmm.gz -o <path to TIGER folder>/db/Pfam-A.hmm.gz
8286

83-
#install gzip if not already available on your system
87+
# install gzip if not already available on your system
8488

8589
conda install conda-forge::gzip
8690

87-
#uncompress PFAM database:
91+
# uncompress PFAM database:
8892

8993
gunzip <path to TIGER folder>/db/Pfam-A.hmm.gz
9094

9195
#IMPORTANT: Fix a bug in Prokka:
92-
# I'm not an author of this program but I've found this bug reported in several forums without an easy solve given. What's happening is that the prokka main script is unable to parse the version number of bioperl that it retrieves with conda correctly (giving the error: Argument "1.7.8" isn't numeric in numeric lt (<)) and thus it exits the program immediately. My "quick and ugly" fix is to hash out the lines in their code that are doing this check. So, in the prokka script (this script should be found at "path to your conda distribution"/envs/"conda env name"/bin/prokka) add a hash (#) to the beginning of lines 256-259 like so:
96+
# I'm not an author of this program but I've found this bug reported in several forums without an
97+
# easy solve given. What's happening is that the prokka main script is unable to parse the version
98+
# number of bioperl that it retrieves with conda correctly (giving the error: Argument "1.7.8" isn't
99+
# numeric in numeric lt (<)) and thus it exits the program immediately. My "quick and ugly" fix is to
100+
# hash out the lines in their code that are doing this check. So, in the prokka script (this script
101+
# should be found at "path to your conda distribution"/envs/"conda env name"/bin/prokka) add a hash
102+
# (#) to the beginning of lines 256-259 like so:
93103

94104
"#my $minbpver = "1.006002"; # for Bio::SearchIO::hmmer3"
95105
"#my $bpver = $Bio::Root::Version::VERSION;"
@@ -130,3 +140,6 @@ The tab-separated fields of the one-line .tax file are:
130140
before rerunning islander.pl: ```rm genome.stats```
131141

132142
before rerunning tiger.pl: ```rm genome.island.nonoverlap.gff```
143+
144+
## Contact
145+
While we're working on a more complete usage guide, please reach out to eltorra@sandia.gov for help if this software is necessary for your research

0 commit comments

Comments
 (0)