Skip to content

Commit

Permalink
updated changes,readme and version
Browse files Browse the repository at this point in the history
  • Loading branch information
jhawkey committed Oct 7, 2015
1 parent 8c49667 commit 66da87c
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 7 deletions.
9 changes: 9 additions & 0 deletions CHANGES.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
v0.1.4, Wed 7 Oct 2015
* can now supply output directory using --directory command
* can now ask BWA to use multiple threads using --t command
* fixed some cases where an unpaired hit would pair incorrectly with itself
* correct distances returned if the flanking gene should be the first or last
gene in the reference
* fixed an error where no hits reported but bed files are non-empty
* possible related IS call must now meet 50% ID and 50% coverage threshold
otherwise the hit is discarded
v0.1.3, Mon 10 Aug 2015
* fixed soft clipped read selection (Special thanks to Katie Cox for helping with this one)
* bam files now deleted by default, can be kept using the --bam flag
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Once ISMapper has finished running, multiple output files will be generated, the

## Common Issues

When running ISMapper on typing mode with a reference genome in Genbank format, check to see if all CDS/tRNA/rRNA features have the locus_tag qualifier. This is the default setting for ISMapper when choosing what to print in the final table. If the reference genome doesn't have locus_tag's, ISMapper will throw an error in the final table create step. This can be avoided by changing the setting of `--cds` (or `--trna` or `--rrna`) flags to db_xref gene product (or whatever other identifiers are present in your genbank file).
When running ISMapper on typing mode with a reference genome in Genbank format, check to see if all CDS/tRNA/rRNA features have the locus_tag qualifier. This is the default setting for ISMapper when choosing what to print in the final table. If the reference genome doesn't have locus_tag's, ISMapper will throw an error in the final table create step. This can be avoided by changing the setting of `--cds` (or `--trna` or `--rrna`) flags to db_xref gene product (or whatever other identifiers are present in your genbank file).

## Adavnced Options for ismap

Expand All @@ -173,7 +173,7 @@ When running ISMapper on typing mode with a reference genome in Genbank format,

`--min_clip` and `--max_clip` are used to determine the size of soft clipped sections of reads that are including in the final mapping step. The default size is currently 10 bp and 30 bp, which is ideal for reads between 100 - 150bp. To improve the detection of the exact target site duplication size, it is sometimes helpful to increase the size of `--max_clip`. However large values of `--max_clip` can increase the amount of noise in the final mapping step and cause nonsensical results.

`--a` and `--T` are flags that are passed to BWA. --a will turn on all alignment reporting in BWA, and --T is used to give an integer mapping score to BWA to determine what alignments are kept. These options may be useful in finding IS query positions that are next to repeated elements as BWA will report all hits for the read not just the best random hit. However, using these options may cause noise and confusion in the final output files.
`--a`, `--T` and `--t` are flags that are passed to BWA. --a will turn on all alignment reporting in BWA, and --T is used to give an integer mapping score to BWA to determine what alignments are kept. These options may be useful in finding IS query positions that are next to repeated elements as BWA will report all hits for the read not just the best random hit. However, using these options may cause noise and confusion in the final output files. `--t` is used to supply more threads to BWA if required.

`--cds`, `--trna` and `--rrna` are used to specify what qualifiers will be looked for in the reference genbank when determining genes flanking the IS query location. Defaults are locus_tag gene product.

Expand All @@ -183,9 +183,11 @@ When running ISMapper on typing mode with a reference genome in Genbank format,

`--log` turns on the log file.

`--directory` sets an output directory for the output files (defualt is the directory where ISMapper is being run).

`--temp` turns on keeping the temporary files instead of deleting them once the run has completed.

`--bam` turns on keeping the final sorted and indexed BAM files of flanking reads for comparison against the reference genome (by default these files are deleted to save disk space).
`--bam` turns on keeping the final sorted and indexed BAM files of flanking reads for comparison against the reference genome (by default these files are deleted to save disk space).


## Other options for compiled_table
Expand All @@ -198,7 +200,7 @@ When running ISMapper on typing mode with a reference genome in Genbank format,

## Running ISMapper without installing

ISMapper can be run directly from its directory without installing it via pip. To do so, ismap.py needs the path to the folder that contains all the scripts supplied to the argument `--path`.
ISMapper can be run directly from its directory without installing it via pip. To do so, ismap.py needs the path to the folder that contains all the scripts supplied to the argument `--path`.

eg:
`ismap.py --reads x_1.fastq.gz x_2.fastq.gz --queries is_query.fasta --path /path/to/IS_mapper/scripts/`
Expand Down Expand Up @@ -254,4 +256,4 @@ optional arguments:
--other_args OTHER_ARGS
String containing all other arguments to pass to
ISMapper
```
```
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

setup(
name='ISMapper',
version='0.1.3',
version='0.1.4',
author='Jane Hawkey',
author_email='[email protected]',
packages=['ismap'],
Expand Down Expand Up @@ -33,4 +33,4 @@
#"scipy >= 0.12.0",
#"biopython == 1.63",
],
)
)

0 comments on commit 66da87c

Please sign in to comment.