magnus167/rustframe
1
0
Fork 0
mirror of https://github.com/Magnus167/rustframe.git synced 2025-11-20 04:06:09 +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

16
src/frame/base.rs
View File

@@ -1,3 +1,19 @@
//! Core data-frame structures such as [`Frame`] and [`RowIndex`].
//!
//! The [`Frame`] type stores column-labelled data with an optional row index
//! and builds upon the [`crate::matrix::Matrix`] type.
//!
//! # Examples
//!
//! ```
//! use rustframe::frame::{Frame, RowIndex};
//! use rustframe::matrix::Matrix;
//!
//! let data = Matrix::from_cols(vec![vec![1, 2], vec![3, 4]]);
//! let frame = Frame::new(data, vec!["L", "R"], Some(RowIndex::Int(vec![10, 20])));
//! assert_eq!(frame.columns(), &["L", "R"]);
//! assert_eq!(frame.index(), &RowIndex::Int(vec![10, 20]));
//! ```
use crate::matrix::Matrix;
use chrono::NaiveDate;
use std::collections::HashMap;