Crate lace_codebook
source ·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_alpha_prior:
!Gamma
shape: 1.0
rate: 1.0
view_alpha_prior:
!Gamma
shape: 1.0
rate: 1.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§
Macros§
Structs§
- Codebook object for storing information about the dataset
- The metadata associated with a column. In addition to the id and name, it contains information about the data model of a column.
- A structure that enforces unique IDs and names.
- The row already exists
- A structure that enforces unique IDs and row names.
Enums§
- Errors that can arise when creating a codebook from a CSV file
- Stores metadata for the specific column types
- Error that can occur when merging the columns of two codebooks
- Errors from a failed
ValueMap.extend