There is a newer version of the record available.

Published May 24, 2022 | Version C_1.0.0
Software Open

tskit-dev/tskit: C API 1.0.0

  • 1. Big Data Institute
  • 2. Oxford University
  • 3. University of Oregon
  • 4. University of Melbourne
  • 5. Broad Institute of MIT and Harvard
  • 6. University of California Irvine
  • 7. Broad Institute
  • 8. @pyupio
  • 9. Nord Software
  • 10. geneheritage.com
  • 11. University of Copenhagen
  • 12. Kern-Ralph Co-Lab, University of Oregon
  • 13. http://sukumaranlab.org
  • 14. Icahn School of Medicine at Mount Sinai
  • 15. University of Oxford

Description

This major release marks the point at which the documented API becomes stable and supported.

Breaking changes

  • Change the type of genotypes to int32_t, removing the TSK_16_BIT_GENOTYPES flag option. (@benjeffery, #463, #2108)

  • tsk_variant_t now includes its tsk_site_t rather than pointing to it. (@benjeffery, #2161, #2162)

  • Rename TSK_TAKE_TABLES to TSK_TAKE_OWNERSHIP. (@benjeffery, #2221, #2222)

  • TSK_DEBUG, TSK_NO_INIT, TSK_NO_CHECK_INTEGRITY and TSK_TAKE_OWNERSHIP have moved to core.h (@benjeffery, #2218, #2230))

  • Rename several flags:

    • All flags to simplify for example TSK_KEEP_INPUT_ROOTS becomes TSK_SIMPLIFY_KEEP_INPUT_ROOTS.
    • All flags to subset for example TSK_KEEP_UNREFERENCED becomes TSK_SUBSET_KEEP_UNREFERENCED.
    • TSK_BUILD_INDEXES -> TSK_TS_INIT_BUILD_INDEXES
    • TSK_NO_METADATA -> TSK_TABLE_NO_METADATA
    • TSK_NO_EDGE_METADATA -> TSK_TC_NO_EDGE_METADATA

    (@benjeffery, #1720, #2226, #2229, #2224)

  • Remove the generic TSK_ERR_OUT_OF_BOUNDS - replacing with specific errors. Remove TSK_ERR_NON_SINGLE_CHAR_MUTATION which was unused. (@benjeffery, #2260)

  • Reorder stats API methods to place result as the last argument. (@benjeffery, #2292, #2285)

Features

Files

tskit-dev/tskit-C_1.0.0.zip

Files (1.1 MB)

Name Size Download all
md5:bd19f1700ae83b03ec93af4663c22453
1.1 MB Preview Download

Additional details

Related works