package biocaml
Install
Dune Dependency
Authors
Maintainers
Sources
md5=4cf944bcae5d36bf47b67f6bcb2455d7
sha512=0262b5768aefd7c080f664c46c88876fce9a658cc6a87358a77b7112c49ae3042e7ab542e76be5738fbaeda853149b308b48d4897960b5c7ae3b4da71d978bd8
doc/biocaml.unix/Biocaml_unix/Chr/index.html
Module Biocaml_unix.Chr
Chromosome names. A chromosome name, as defined by this module, consists of two parts. An optional prefix "chr" (case-insensitive), followed by a suffix identifying the chromosome. The possible suffixes (case-insensitive) are:
- "X" representing the maternal chromosome
- "Y" representing the paternal chromosome
- "M", "Mt", or "MtDNA" representing mitochondrial DNA
- "N" where N is a positive number in either arabic or roman numeral form
Some suffixes have ambiguous interpretations, e.g. "X" could be a Roman numeral or the maternal chromosome. Preference is given to the non-numeric interpretation. Thus "chrX" is treated as the maternal chromosome, not chromosome 10. Strings not in the above form are left unaltered by the functions of this module.
Functions for converting to an Arabic or Roman format are provided. The benefit is that these functions convert to a canonical form, and thus the resulting strings can be compared reliably. For example, to_arabic "Chr4"
and to_arabic "IV"
both return "4". The Arabic format is recommended over the Roman form because the Roman form is incomplete; e.g. it cannot represent chromosome number 10 because there would be an ambiguity with the maternal chromosome "chrX".
module Error : sig ... end
exception Error of Error.t
val to_roman : string -> (string, Error.t) Core_kernel.Result.t
to_roman s
returns the canonical Roman representation of s
.