raphtory 0.17.0

raphtory, a temporal graph library
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
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

//! Load the Lord of the Rings dataset into a graph.
//! The dataset is available at https://raw.githubusercontent.com/Raphtory/Data/main/lotr.csv
//! and is a list of interactions between characters in the Lord of the Rings books
//! and movies. The dataset is a CSV file with the following columns:
//!
//! - src_id: The ID of the source character
//! - dst_id: The ID of the destination character
//! - time: The time of the interaction (in page)
//!
//! ## Dataset statistics
//! * Number of nodes (characters) 139
//! * Number of edges (interactions) 701
//!
//! Example:
//! ```rust,no_run
//! use raphtory::graph_loader::lotr_graph::lotr_graph;
//! use raphtory::prelude::*;
//!
//! let graph = lotr_graph();
//!
//! println!("The graph has {:?} nodes", graph.count_nodes());
//! println!("The graph has {:?} edges", graph.count_edges());
//! ```
use crate::{graph_loader::fetch_file, io::csv_loader::CsvLoader, prelude::*};
use serde::Deserialize;
use std::{collections::HashMap, path::PathBuf};
use tracing::error;

#[derive(Deserialize, std::fmt::Debug)]
pub struct Lotr {
    pub src_id: String,
    pub dst_id: String,
    pub time: i64,
}

/// Downloads the LOTR.csv file from Github
/// and returns the path to the file
///
/// Returns:
/// - A PathBuf to the LOTR.csv file
pub fn lotr_file() -> Result<PathBuf, Box<dyn std::error::Error>> {
    fetch_file(
        "lotr.csv",
        true,
        "https://raw.githubusercontent.com/Raphtory/Data/main/lotr.csv",
        600,
    )
}

#[derive(Deserialize, std::fmt::Debug)]
struct Character {
    pub name: String,
    pub race: String,
    pub gender: String,
}

/// Downloads the LOTR.csv file from Github
/// and returns the path to the file
///
/// Returns:
/// - A PathBuf to the LOTR.csv file
fn lotr_properties_file() -> Result<PathBuf, Box<dyn std::error::Error>> {
    fetch_file(
        "lotr_properties.csv",
        true,
        "https://raw.githubusercontent.com/Raphtory/Data/main/lotr_properties.csv",
        600,
    )
}

/// Constructs a graph from the LOTR dataset
/// Including all edges, nodes and timestamps
///
/// # Arguments
///
/// - shards: The number of shards to use for the graph
///
/// Returns:
/// - A Graph containing the LOTR dataset
pub fn lotr_graph() -> Graph {
    let g = Graph::new();
    CsvLoader::new(lotr_file().unwrap())
        .load_into_graph(&g, |lotr: Lotr, g: &Graph| {
            let src_id = lotr.src_id;
            let dst_id = lotr.dst_id;
            let time = lotr.time;

            g.add_node(time, src_id.clone(), NO_PROPS, None)
                .map_err(|err| error!("{:?}", err))
                .ok();
            g.add_node(time, dst_id.clone(), NO_PROPS, None)
                .map_err(|err| error!("{:?}", err))
                .ok();
            g.add_edge(time, src_id.clone(), dst_id.clone(), NO_PROPS, None)
                .expect("Error: Unable to add edge");
        })
        .expect("Failed to load graph from CSV data files");
    g
}

/// Constructs a graph from the LOTR dataset
/// Including all edges, nodes, and timestamps with some node types
///
/// # Arguments
///
/// - shards: The number of shards to use for the graph
///
/// Returns:
/// - A Graph containing the LOTR dataset
pub fn lotr_graph_with_props() -> Graph {
    let g = lotr_graph();
    CsvLoader::new(lotr_properties_file().unwrap())
        .load_into_graph(&g, |char: Character, g: &Graph| {
            if let Some(node) = g.node(char.name) {
                let _ = node.add_metadata(HashMap::from([
                    ("race", char.race),
                    ("gender", char.gender),
                ]));
            }
        })
        .expect("Failed to load graph from CSV data files");
    g
}