Crate lace_codebook

Expand description

The Codebook is a YAML file used to associate metadata with the dataset. The user can set the priors on the structure of each state, can identify the model for each columns, and set hyper priors.

Often the data has too many columns to write a codebook manually, so there are functions to guess at a default codebook given a dataset. The user can then edit the default file.

§Example

An Example codebook for a two-column dataset.

use indoc::indoc;

let codebook_str = indoc!("
    ---
    table_name: two column dataset
    state_prior_process:
      !dirichlet
        alpha_prior:
          shape: 1.0
          rate: 1.0
    view_prior_process:
      !pitman_yor
        alpha_prior:
          shape: 1.0
          rate: 1.0
        d_prior:
          alpha: 1.0
          beta: 2.0
    col_metadata:
      - name: col_1
        notes: first column with all fields filled in
        coltype:
          !Categorical
            k: 3
            hyper:
              pr_alpha:
                shape: 1.0
                scale: 1.0
            prior:
                k: 3
                alpha: 0.5
            value_map: !string
              0: red
              1: green
              2: blue
      - name: col_2
        notes: A binary column with optional fields left out
        coltype:
          !Categorical
            k: 2
            value_map: !u8 2
    comments: An example codebook
    row_names:
      - A
      - B
      - C
      - D
      - E");

let codebook: Codebook = serde_yaml::from_str(&codebook_str).unwrap();

assert_eq!(codebook.col_metadata.len(), 2);

Modules§

data

Macros§

series_to_opt_strings
series_to_opt_vec
series_to_strings
series_to_vec

Structs§

CategoryIter
CategoryMap
Codebook: Codebook object for storing information about the dataset
ColMetadata: The metadata associated with a column. In addition to the id and name, it contains information about the data model of a column.
ColMetadataList: A structure that enforces unique IDs and names.
InsertRowError: The row already exists
RowNameList: A structure that enforces unique IDs and row names.

Enums§