package biocaml

  1. Overview
  2. Docs
package biocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

Definition of rows

type item = [
  1. | `int of int
  2. | `float of float
  3. | `string of string
]

Type row elements (or “cells”).

type t = item array

A single row.

type item_type = [
  1. | `type_int
  2. | `type_float
  3. | `type_string
]

Definition of the type of a cell.

type t_type = item_type array

Definition of the type of a row.

Tags

module Tags : sig ... end

Tags describe the actual format of the row stream. See also Tags.t.

module Error : sig ... end
val of_line : ?separators:char list -> ?strict_row_length:bool -> ?strict_cell_type:bool -> ?format:t_type -> Line.t -> (t, [> Error.line_parsing ]) Core_kernel.Result.t

Parse a Line.t into a row while specifying a format.

  • If format is None (the default), then all the elements are put in `string _ rows.
  • The default cell separators are [' '; '\t'].
  • If strict_row_length is true and format provided, then check that the number of columns is at least the one of the format.
  • If strict_cell_type is true and format provided, then check that each cell has the exactly right format.
val to_line : sep:string -> t -> Line.t

Write the row to a Line.t.

Transform.t Creations

module Transform : sig ... end

S-Expressions

val item_of_sexp : Sexplib.Sexp.t -> item
val sexp_of_item : item -> Sexplib.Sexp.t
val t_of_sexp : Sexplib.Sexp.t -> t
val sexp_of_t : t -> Sexplib.Sexp.t
val item_type_of_sexp : Sexplib.Sexp.t -> item_type
val sexp_of_item_type : item_type -> Sexplib.Sexp.t
val t_type_of_sexp : Sexplib.Sexp.t -> t_type
val sexp_of_t_type : t_type -> Sexplib.Sexp.t