Skip to content

ibdsim2 2.0.0

Compare
Choose a tag to compare
@magnusdv magnusdv released this 18 Aug 07:28

Breaking changes

  • As of version 2.0.0, the main data structure for IBD segments includes both megabase (MB) and centiMorgan (CM) coordinates. This allows the user to choose length unit in all downstream analyses. However, the new format is not compatible with previous versions of the package.

  • ibdsim() has a new argument simplify1, by default TRUE. This means that ibdsim(..., N = 1) now simply returns a matrix, without the outer list layer. This typically the desired behaviour in interactive use, especially when piping. To enforce a list output, add simplify1 = FALSE.

New features

  • All downstream functions depending on segment lengths (e.g. segmentStats() and plotSegmentDistribution()) have a new argument unit, allowing the user to choose between "cm" (centiMorgan) and "mb" (megabases).

  • haploDraw() has nicer default colours and automatically produces sensible margins.

  • New (experimental) function karyoHaploid() for visualising IBD segments in karyogram plots.

  • convertPos() has been rewritten using Rcpp, making it much more efficient.

  • General overhaul of documentation, examples and README.