1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

//! 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 lace_codebook::Codebook;
//! 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);
//! ```
#![warn(unused_extern_crates)]
#![warn(
    clippy::all,
    clippy::imprecise_flops,
    clippy::suboptimal_flops,
    clippy::unseparated_literal_suffix,
    clippy::unreadable_literal,
    clippy::option_option,
    clippy::implicit_clone
)]

mod codebook;
pub mod data;
mod error;
mod value_map;

#[cfg(feature = "formats")]
pub mod formats;

pub use codebook::*;
pub use error::*;
pub use value_map::{
    CategoryIter, CategoryMap, ValueMap, ValueMapExtension,
    ValueMapExtensionError,
};