Skip to content

Releases: nanoporetech/modkit

v0.5.0

21 May 16:29
Compare
Choose a tag to compare

Adds

  • [open-chromatin] Adds open chromatin prediction subcommand for 6mA MTase-treated DNA
  • [all] Fallback to ML 254 when threshold is estimated as 1.0

Changes

  • [all] Refactor to workspaces
  • [modbam, check-tags] Adds --head <n> option to take first n reads

Fixes

  • [stats] Allow BED5 input regions and header/comment lines

v0.4.4

09 Apr 04:37
Compare
Choose a tag to compare

Adds

  • [extract] Adds alignment start and end columns
  • [extract] Adds motif annotation column
  • [localize] Allow BED4 input regions
  • [dmr] Improve logging and error reporting, adds --careful to output table of contigs that can be processed.
  • [dmr] Adds Cohen's h statistic
  • [motif, search] Adds "batch and narrow" exhaustive search algorithm
  • [motif, search] Adds structured logging

Changes

  • [all] Any output that is BED-like will have headers with "#" comment symbol
  • [dmr] Change maximum allowed coverage in MAP-based p-value from 300 to 100.

Fixes

  • [all] Correctly parse "transcript"-like contigs for --region arguments
  • [dmr] Correctly handle bedMethyl tables with multiple motifs in the name column

Documentation missing
This build comes with documentation (a manual) that is missing the description of Cohen's h statistic in the DMR output. The online version of the manual has been updated.

Changelog missing

  • [dmr] Change maximum allowed coverage in MAP-based p-value from 300 to 100.

Is not present in the tagged version of the Changelog.

v0.4.4-rc1

20 Feb 02:19
Compare
Choose a tag to compare

Fixes

  • [bedmethyl, merge] Merge and write concurrently, improves memory usage and runtime massively.
  • [dmr] Don't fail an entire section (i.e. batch) when one sample does not have a particular contig.
  • [modbam, check-tags] Fix counter so that records that fail reading are counted.
  • [pileup, sampler] Don't use non-primary alignments when calculating pass thresholds.

v0.4.3

30 Jan 20:01
Compare
Choose a tag to compare

Adds

  • [bedmethyl] Extract bigWig tracks from bedMethyl files
  • [modbam] check-tags command to validate MM/ML tags
  • Allow "generic" MM tags
  • Add error-tabulation table to most commands

Fixes

  • [sample-probs] Make colors the same in the output charts (fixes #345).
  • [bedmethyl, merge] Perform an outer join as stated in the documenttion (fixes #334).
  • [pileup] BAM-header ordering of contigs when using --include-bed

v0.4.2

21 Dec 04:55
Compare
Choose a tag to compare

Adds

  • [entropy] Entropy can now be calculated with multiple motifs and multiple modified primary bases.
  • [adjust-mods, call-mods] Retain or remove base modification calls based on whether they match a sequence motif in the basecall sequence.
  • [bedmethyl] Add command to merge bedMethyl files.
  • [dmr] Add strand to DMR output.

v0.4.1

27 Sep 19:57
Compare
Choose a tag to compare

Adds

  • [docs] Fix documentation links
  • [dmr] Address bug where assert fires when one sample does not have any records over a region, fixes #265A

Fixes

  • [sample-probs] Add arguments to specify the colors of the histogram output, also make them deterministic when not given
  • [summary] Make table ordering deterministic.

v0.4.0

17 Sep 16:37
Compare
Choose a tag to compare

Adds

  • [motif] Add search and evaluate subcommands under motif command hierarchy.
  • [stats, localize] Add stats and localize commands, see documentation for details.
  • [dmr, multi] Combine samples when they have the same name.
  • [extract] Add option to emit bgzf-compressed output.

Fixes

  • [validate] Only consider modification codes attributed to the primary sequence base being validated.
  • [pileup, extract] Improve iteration over regions when --include-bed is provided.

Changes

  • [dmr] Use htslib tbx module for reading tabix index instead of noodles.
  • [pileup] Require .fai FASTA index when a reference is provided, load only sections of reference that are necessary.
  • [extract] Separate calls and full commands to produce the read calls, and full tables, respectively.
  • [validate] Change "any-mod" code from {A, C, G, T} to *.

v0.3.3

07 Sep 14:36
Compare
Choose a tag to compare

Fixes

  • [sample-probs, summary, pileup] Refactor sampling algorithm so that it will not over-sample reads leading to excessive memory usage.
  • [validate] Only use modifications on the canonical base we're validating (in case the modBAM has multiple, e.g. A and C-mods).
  • [entropy] Check that reference sequences are the same as in the bam header

v0.3.2

15 Aug 23:39
Compare
Choose a tag to compare

Fixes

  • [thresholds] OOB panic fix, #244
  • [dmr, pair] Allow strand information in regions to be provided. #240
  • [dmr, multi] Fix problem when many pairs are provided (#229)

Adds

  • [sample-probs] Change output format of probabilities table to make it easier to parse, also change schema. Output HTML documents with nicer tables.
  • [ci] Build in Ubuntu-16 due to Centos7 EOL.

v0.3.1

22 Jun 01:53
Compare
Choose a tag to compare

Fixes

  • [call-mods] Always change model to "explicit", dropped base modification probabilities should not be interpreted as canonical.
  • [dmr, segment] Add pseudo-count to avoid -inf in HMM.
  • [find-motifs] Fix crash in exhaustive search.

Adds

  • [dmr] Allow specification of mod code-to-primary base on the command line with --assign-code.