rustalib 1.0.9

A library of technical indicators for financial analysis, similar to TA-Lib
Documentation 
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

// Volume indicators module

use polars::prelude::*;

// Modules for volume indicators
mod adl;
mod cmf;
mod eom;
mod mfi;
mod obv;
mod pvt;

// Re-export volume indicators
pub use adl::calculate_adl;
pub use cmf::calculate_cmf;
pub use eom::calculate_eom;
pub use mfi::calculate_mfi;
pub use obv::calculate_obv;
pub use pvt::calculate_pvt;

/// Add volume-based indicators to a DataFrame
///
/// This function calculates and adds multiple volume-based indicators to the input DataFrame,
/// which is useful for combining multiple indicators in a single call.
///
/// # Arguments
///
/// * `df` - DataFrame containing OHLCV data
///
/// # Returns
///
/// * `PolarsResult<DataFrame>` - DataFrame with added volume indicators
///
/// # Example
///
/// ```
/// use polars::prelude::*;
/// use ta_lib_in_rust::indicators::volume::add_volume_indicators;
///
/// // Create or load a DataFrame with OHLCV data
/// let df = DataFrame::default(); // Replace with actual data
///
/// // Add volume indicators
/// let df_with_indicators = add_volume_indicators(&df).unwrap();
/// ```
pub fn add_volume_indicators(df: &DataFrame) -> PolarsResult<DataFrame> {
    let mut result_df = df.clone();

    // Calculate On Balance Volume (OBV)
    let obv = calculate_obv(df)?;
    result_df.with_column(obv)?;

    // Calculate Chaikin Money Flow (CMF) with default period of 20
    let cmf = calculate_cmf(df, 20)?;
    result_df.with_column(cmf)?;

    // Calculate Money Flow Index (MFI) with default period of 14
    let mfi = calculate_mfi(df, 14)?;
    result_df.with_column(mfi)?;

    Ok(result_df)
}