magnus167/rustframe
1
0
Fork 0
mirror of https://github.com/Magnus167/rustframe.git synced 2025-11-19 13:36:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enhance documentation with usage examples for core data-frame structures and operations

Browse Source
This commit is contained in:
Palash Tyagi
2025-08-03 16:46:20 +01:00
parent 676f78bb1e
commit d1dd7ea6d2
3 changed files with 47 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/frame/mod.rs
View File

@@ -1,3 +1,21 @@
//! High-level interface for working with columnar data and row indices.
//!
//! The [`Frame`](crate::frame::Frame) type combines a matrix with column labels and a typed row
//! index, similar to data frames in other data-analysis libraries.
//!
//! # Examples
//!
//! ```
//! use rustframe::frame::{Frame, RowIndex};
//! use rustframe::matrix::Matrix;
//!
//! // Build a frame from two columns labelled "A" and "B".
//! let data = Matrix::from_cols(vec![vec![1.0, 2.0], vec![3.0, 4.0]]);
//! let frame = Frame::new(data, vec!["A", "B"], None);
//!
//! assert_eq!(frame["A"], vec![1.0, 2.0]);
//! assert_eq!(frame.index(), &RowIndex::Range(0..2));
//! ```
pub mod base;
pub mod ops;