package biocaml

  1. Overview
  2. Docs
On This Page
  1. I/O
package biocaml
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Biocaml_unix.BpmapSource

Affymetrix's BPMAP files. Only text format supported. Binary BPMAP files must first be converted to text using Affymetrix's probe exporter tool.

Sourcetype probe = {
  1. org_name : string;
    (*

    name of organism on which probe is based

    *)
  2. version : string;
    (*

    genome build version on which probe is based

    *)
  3. chr_name : string;
    (*

    name of chromosome on which probe is based

    *)
  4. start_pos : int;
    (*

    start position of probe on given chromosome

    *)
  5. sequence : Seq.t;
    (*

    sequence of the perfect match probe

    *)
}
Sourcetype row = {
  1. pmcoord : int * int;
    (*

    x,y-coordinates of perfect match probe.

    *)
  2. mmcoord : int * int;
    (*

    x,y-coordinates of mismatch probe

    *)
  3. probe : probe;
}

Type of information on one data row.

Sourcetype t

Type of a BPMAP file.

Sourceexception Bad of string

Raised when encountering ill-formed BPMAP.

Sourceval num_probes : t -> int

Number of PM/MM probe pairs in given BPMAP. The number of total probes is twice this value.

Sourceval col_names : string list

Names of columns in BPMAP file, in the order required by specification.

Sourceval iter : (row -> unit) -> t -> unit
Sourceval fold : ('a -> row -> 'a) -> 'a -> t -> 'a
Sourceval to_list : t -> row list
I/O
Sourceval of_file : ?chr_map:(string -> string) -> string -> t

of_file file parses file. If given, chr_map is applied to every chromosome name. Raise Bad if there is a parse error.

Sourceval row_to_string : row -> string

String representation of row in same format as required by specification.

Sourceval to_file : string -> t -> unit

to_file file t prints t to file in format required by specification.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct