CHANGES.md

Changes

v1.1.28 (2020.06.05)

• Further fix for #100

v1.1.27 (2020.06.01)

• Fix #100 - use correct property to determine timeout when running qc in parallel

v1.1.26 (2020.05.04)

• Fix #97 - handle single-end data in QC report

v1.1.25 (2020.01.10)

• Fix #71 - handle corrupted adapter cache file

v1.1.24 (2019.11.27)

• Fix #87 - Python 3.8 compatibility, time.clock removed

v1.1.23 (2019.11.22)

• Set minimum Python version to 3.4.5
• Fixed #86 - no trimming performed for single-end BAM file

v1.1.22 (2019.05.20)

• Documentation fixes (#79)
• Fix for index error when running detect command (#80)

v1.1.21 (2018.11.24)

• Added long options for paired adapter parameters.

v1.1.20 (2018.11.21)

• Fix #74: Make pysam open SAM/BAM files with check_sq=False by default
• Fixed setup.py to correctly include README for PyPI.

v1.1.19 (2018.05.16)

• Fix #68: Error when using insert aligner with adapters of different lengths

v1.1.18 (2018.03.16)

• Added two new tools to the benchmarks:
  • fastp
  • Cutadapt
• Updated versions of several tools used in the paper. Rebuilt containers and pushed them to Dockerhub.
• Fix #64: InsertAligner not respecting match_adapter_wildcards and match_read_wildcards options.

v1.1.17 (2018.01.13)

• Fix #51: Reads of different lengths not error corrected.

v1.1.16 (2018.01.07)

• Fix for #57: LegacyReport stops on adapter with no trimmed reads, and LegacyReport errors when histogram data is None. Thanks to @cokelaer and @pyMyt1!
• Fix for #58: NextSeqTrimmer not trimming from both ends. Thanks to @pkMyt1!

v1.1.15 (2017.09.28)

• Fix for #41: Error when using progress bar.
• Fix for #42: Discordance between Cutadapt and Atropos in number of expected events.
• Added '--alphabet' option. Set to 'dna' to validate input sequences against the allowed DNA characters (A/C/G/T/N). This fixes #43 and partially fixes #44.
• Fixed #44: Uncaught errors not being logged.

v1.1.14 (2017.09.19)

• Fix for #39: miRNA option error (thanks to @mottodora)
• Fix for #37: fixes overflow error when computing RandomMatchProbability on long reads (>150 bp)

v1.1.13 (2017.09.14)

• Fix for #38: Atropos fails with MultiCore error when using OrderPreservingWriterResultsHandler (thanks to @cshenanigans)

v1.1.12 (2017.08.15)

• Expose --min-frequency and --min-contaminant-match-frac options to 'detect -d heuristic' command.
• Expose --min-kmer-match-frac option to 'detect -d known' command.
• Fixed #35: using incorrect metric to determine match fraction in 'detect -d known' command.

v1.1.11 (2017.08.15)

• Fixed #34: JSON report output not working with SRA streaming.

v1.1.10 (2017.08.09)

• Improve debugging messages

v1.1.9 (2017.08.01)

• Fix #30: failure when using --preserve-order option

v1.1.8 (2017.07.10)

• Add --config option for specifying options in a config file.
• Fix for #29: allow paired-end quality and N trimming without adapter trimming.
• Removed twine register command from make release

v1.1.7 (2017.06.01)

• Stream reads directly from an SRA accession for any atropos command using the -sra option.
• Add detect option to specify the bases that signify when the sequencer has read past the end of a fragment.

v1.1.6 (2017.05.30)

• Add FASTA output for detect command, and enable json, yaml, and pickle output for all commands.

v1.1.5 (2017.05.18)

• Major update to the documentation.
• Fixed error messages in multi-threaded mode.
• Fixed bug when generating reports for runs involving error correction.

v1.1.4 (2017.05.02)

• Exposed option to set PRNG seed when subsampling reads.
• Fixed issue #14: 'detect' and 'error' commands were broken. This involved rewriting those commands to use the same pipeline and reporting frameworks as the 'trim' and 'qc' commands.

v1.1.3 (2017.05.01)

• Updated Dockerfile to use smaller, Alpine-based image.
• Added Docker image for v1.1.2 to Docker Hub.
• Updated Travis config to automatically build Docker images for each release.
• Ported over improvements to adapter parsing (635eea9) from Cutadapt.
• Fixed #12: tqdm progress bar not working.
• Fixed #13: unnecessary differences in summary output between Cutadapt and Atropos.

v1.1.2 (2017.04.12)

• New 'qc' command computes read-level statistics.
• The 'trim' command can also compute read-level statistic pre- and/or post-trimming using the new '--stats' option.
• Major refactoring and improvement of reporting:
  • Text report now has data lined up in columns.
  • Reports can also be generated in JSON, YAML, and pickle formats.
  • Added optional dependency on jinja2, which enables generating reports using templates (including user-defined).
• Major internal code reorganization.
• Static code analysis (pylint).
• Switched to pytest for testing.
• Command-specific help will now show with 'atropos ' or 'atropos -h'
• Fixed adapter masking in InsertAligner (issue #7; thanks @lllaaa).
• Added developer/contributor documentation and guidelines.
• Implemented Atropos module for MultiQC, which reads reports in JSON format. This is currently available here and will hopefully soon be merged into MultiQC.
• Ported some recent enhancments over from Cutadapt.

v1.0.23 (2016.12.07)

• Identified a subtle bug having to do with insufficient memory in multi-threaded mode. The main thread appears to hang waiting for the next read from the input file. This appears to occur only under a strictly-regulated memory cap such as on cluster environment. This bug is not fixed, but I added the following:
  • Set the default batch size based on the queue sizes
  • Warn the user if their combination of batch and queue sizes might lead to excessive memory usage.
• Bug fixes

v1.0.22 (2016.12.02)

• Abstracted the ErrorEstimator class to enable alternate implementations.
• Added a new ShadowRegressionErrorEstimator that uses the ShadowRegression R package (Wang et al.) to more accurately estimate sequencing error rate. This requires that R and the ShadowRegression package and its dependencies be installed -- MASS and ReadCount, which in turn depend on a bunch of Bioconductor packages. At some point, this dependency will go away when I reimplement the method in pure python.
• The error command now reports the longest matching read fragment, which is usually a closer match for the actual adapter sequence than the longest matching k-mer.

v1.0.21 (2016.11.23)

• Bugfixes

v1.0.20 (2016.11.22)

• Changed the order of trimming operations - OverwriteReadModifier is now after read and quality trimming.
• Refactored the main Atropos interface to improve testability.
• Added more unit tests.

v1.0.19 (2016.11.21)

• Fixed a major bug in OverwriteReadModifier, and in the unit tests for paired-end trimmers.

v1.0.18 (2016.11.20)

• Added OverwriteReadModifier, a paired-end modifier that overwrites one read end with the other if the mean quality over the first N bases (where N is user-specified) of one is below a threshold value and the mean quality of the other is above a second threshold. This dramatically improves the number of high-quality read mappings in data sets where there are systematic problems with one read-end.

v1.0.17 (2016.11.18)

• Perform error correction when insert match fails but adapter matches are complementary
• Improvements to handling of cached adapter lists
• Merged reads are no longer written to --too-short-output by default
• Many bugfixes and improvements in deployment (including a Makefile)
• Many

v1.0.16 (2016.09.20)

• Migrate to Versioneer for version management.
• Enable stderr as a valid output using the '_' shortcut.
• Add ability to specify SAM/BAM as input format.
• Add option to select which read to use when treating a paired-end interleaved or SAM/BAM file as single-end.
• Remove restrictions on the use of --merge-overlapping, and enable error correction during merging.
• We are beginning to move towards the use of commands for all operations, and read-trimming now falls under the 'trim' command. Currently, calling atropos without any command will default to the 'trim' command.
• When InsertAdapterCutter.symmetric is True and mismatch_action is not None, insert match fails, at least one adapter match succeeds, and the adapter matches (if there are two) are complementary, then the reads are treated as overlapping and error correction is performed. This leads to substantial improvements when one read is of good quality while the other is other is of poor quality.

v1.0.15 (2016.09.14)

• Fixed missing import bug in 'detect' command.
• Added estimate of fraction of contaminated reads to output of 'detect' command.
• Optionally cache list of known contaminants rather than re-download it every time.

v1.0.14 (2016.09.13)

• Implemented _align.MultiAligner, which returns all matches that satisfy the overlap and error thresholds. align.InsertAligner now uses MultiAligner for insert matching, and tests all matches in decreasing size order until it finds one with adapter matches (if any).
• Major improvements to the accuracy of the 'detect' command.
• Added options for how to correct mismatched bases for which qualities are equal.
• Added option to select a single pair of adapters from multiple sequences in a fasta file.
• Fixed report when insert-match is used.
• Fixed several bugs when using the "message" progress bar (thanks to Thomas Cokelaer!).
• Fixed a segmentation fault that occurs when trying to trim zero-length reads with the insert aligner.
• Sevaral other bugfixes.

v1.0.13 (2016.08.31)

• Add options to specify max error rates for insert and adapter matching within insert aligner.
• Add new command to estimate empirical error rate in data set from base qualities.

v1.0.12 (2016.08.30)

• Add ability to correct errors during insert-match adapter trimming.
• Implement additional adapter-detection algorithms.
• Fix bug where default output file is force-created in parallel-write mode

v1.0.11 (2016.08.24)

• Clarify and fix issues with bisulfite trimming. Notably, rrbs and non-directional are now allowed independently or in combination.

v1.0.10 (2016.08.23)

• Introduced new 'detect' command for automatically detecting adapter sequences.
• Options are now required to specify input files.
• Major updates to documentation.

v1.0.9 (2016.08.22)

• Bugfix release

v1.0.8 (2016.08.19)

• Reverted previously introduced (and no longer necessary) dependency on bitarray).
• Switched the insert aligner back to the default implementation, as the one that ignores indels is not any faster.

v1.0.7 (2016.08.18)

• Re-engineered modifiers.py (and all dependent code) to enable use of modifiers that simultaneously edit both reads in a pair.
• Add --op-order option to enable use to specify order of first four trimming operations.
• Implemented insert-based alignment for paired-end adapter trimming. This is currently experimental. Benchmarking against SeqPurge and Skewer using simulated reads showed that the method Cutadapt uses to align adapters, while optimal for single-end reads, is much less sensitive and specific than the insert match algorithms used by SeqPurge and Skewer. Our algorithm is similar to the one used by SeqPurge but leverages the dynamic programming model of Cutadapt.

v1.0.6 (2016.08.08)

• Based on tests, worker compression is faster than writer compression when more than 8 threads are available, so set this to be the default.

v1.0.5 (2016.08.06)

• Interanal code reorganization - compression code moved to separate module
• Eliminated the --worker-compression option in favor of --compression (whose value is either 'worker' or 'writer')
• More documentation improvements

v1.0.3 (2016.08.05)

• Significant performance improvements:
  • Start an extra worker once the main process is finished loading reads
  • Use system-level gzip for writer compression
  • Use writer compression by default
• More documentation fixes
• Disable quality trimming if all cutoffs are set to 0
• Eliminated the --parallel-environment option

v1.0.1 (2016.08.04)

• Fix documentation bugs associated with migration from optparse to argparse

v1.0 (2016.07.29)

• Initial release (forked from cutadapt 1.10)
• Re-wrote much of filters.py and modifiers.py to separate modifying/filtering from file writing.
  • File writing is now managed by a separate class (seqio.Writers)
  • There are container classes for managing filters (filters.Filters) and modifiers (modifiers.Modifiers)
• Re-wrote all of the output-oriented code in seqio.py
  • Formatting Sequence objects is now separate from writing data
  • There is a container class (seqio.Formatters) that manages the formatters for output files
  • Added support for interleaved output
• Implemented multiprocessing
  • Added several new options in scripts.atropos to control parallelization
  • Wrote all of the parallel processing code in atropos.multicore
  • Renamed scripts.atropos.process_single_reads() to scripts.atropos.run_serial() and rewrote to work similarly to atropos.multicore.run_parallel()
  • Added ability to merge report statistics from multiple worker threads
• Added miRNA and bisulfite sequencing options to scripts.atropos
• Added progress bar support
• Switched argument parsing to argparse
• Reorganized the monolithic scripts.atropos.main() into multiple functions
• Dropped all support for python 2.x