Module Biocaml.PhredScore

module PhredScore: Biocaml_phredScore

exception Error of string

type t

val of_ascii : ?offset:[ `offset33 | `offset64 ] -> char -> t

of_ascii ~offset x returns the PHRED score encoded by ASCII character x.
Raises Error if x does not represent a valid score.

val to_ascii : ?offset:[ `offset33 | `offset64 ] -> t -> char

to_ascii t encodes t as an ASCII character.
Raises Error if t with the given offset cannot be encoded as a visible ASCII character (codes 33 - 126).

val of_int : int -> t

of_int x returns the PHRED score with the same value x, but assures that x is non-negative.
Raises Error if x is negative.

val to_int : t -> int

val of_probability : ?f:(float -> int) -> float -> t

of_probability ~f x returns -10 * log_10(x), which is the definition of PHRED scores.

PHRED scores are integral, and it is unclear what convention is used to convert the resulting float value to an integer. Thus, the optional f is provided to dictate this. The default is to round the computed score to the closest integer.
Raises Error if x is not between 0.0 - 1.0.

val to_probability : t -> float

to_probablity x converts x to a probablity score. Note this is not the inverse of of_probability due to the rounding done by the latter.

val of_solexa_score : ?f:(float -> int) -> Biocaml_solexaScore.t -> t

of_solexa_score x converts Solexa score x to a PHRED score.

The conversion produces a float, and it is unclear what convention is used to convert the resulting float value to an integer. As in Biocaml_phredScore.of_probability, the optional f parameter is provided to dictate this.

val to_solexa_score : ?f:(float -> int) -> t -> Biocaml_solexaScore.t

to_solexa_score t converts PHRED score t to a Solexa score.