xportrs 0.0.8

CDISC-compliant XPT file generation and parsing library for Rust
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
//! Polars `DataFrame` integration.
//!
//! This module provides conversion between xportrs [`Dataset`] and Polars
//! [`DataFrame`](polars::frame::DataFrame) types.
//!
//! # Feature Flag
//!
//! This module requires the `polars` feature:
//!
//! ```toml
//! [dependencies]
//! xportrs = { version = "0.1", features = ["polars"] }
//! ```
//!
//! # Examples
//!
//! ## Converting `Dataset` to `DataFrame`
//!
//! ```
//! use xportrs::{Dataset, dataset::{Column, ColumnData}, polars::IntoDataFrame};
//!
//! let dataset = Dataset::new(
//!     "AE",
//!     vec![
//!         Column::new("USUBJID", ColumnData::String(vec![Some("01-001".into())])),
//!         Column::new("AESEQ", ColumnData::I64(vec![Some(1)])),
//!     ],
//! ).unwrap();
//!
//! let df = dataset.into_dataframe().unwrap();
//! assert_eq!(df.width(), 2);
//! ```
//!
//! ## Converting `DataFrame` to `Dataset`
//!
//! ```
//! use xportrs::{Dataset, polars::FromDataFrame};
//! use polars::prelude::*;
//!
//! let s1 = Series::new("USUBJID".into(), &["01-001", "01-002"]);
//! let s2 = Series::new("AESEQ".into(), &[1i64, 2i64]);
//! let df = DataFrame::new(vec![s1.into(), s2.into()]).unwrap();
//!
//! let dataset = Dataset::from_dataframe("AE", df).unwrap();
//! assert_eq!(dataset.ncols(), 2);
//! ```

use chrono::Timelike;
use polars::prelude::*;

use crate::dataset::{Column as XptColumn, ColumnData, Dataset, DomainCode};
use crate::error::{Error, Result};

/// Extension trait for converting a [`Dataset`] into a Polars [`DataFrame`].
pub trait IntoDataFrame {
    /// Converts this dataset into a Polars `DataFrame`.
    ///
    /// # Errors
    ///
    /// Returns an error if the conversion fails due to incompatible data types.
    fn into_dataframe(self) -> Result<DataFrame>;
}

/// Extension trait for creating a [`Dataset`] from a Polars [`DataFrame`].
pub trait FromDataFrame: Sized {
    /// Creates a dataset from a Polars `DataFrame`.
    ///
    /// # Arguments
    ///
    /// * `domain_code` - The domain code for the dataset (e.g., "AE", "DM")
    /// * `df` - The Polars `DataFrame` to convert
    ///
    /// # Errors
    ///
    /// Returns an error if the conversion fails due to incompatible data types.
    fn from_dataframe(domain_code: impl Into<DomainCode>, df: DataFrame) -> Result<Self>;
}

impl IntoDataFrame for Dataset {
    fn into_dataframe(self) -> Result<DataFrame> {
        let mut columns: Vec<Column> = Vec::with_capacity(self.columns().len());

        for col in self.columns() {
            let series = column_data_to_series(col.name(), col.data())?;
            columns.push(series.into());
        }

        DataFrame::new(columns).map_err(|e| Error::Polars {
            message: e.to_string(),
        })
    }
}

impl FromDataFrame for Dataset {
    fn from_dataframe(domain_code: impl Into<DomainCode>, df: DataFrame) -> Result<Self> {
        let mut columns: Vec<XptColumn> = Vec::with_capacity(df.width());

        for col in df.get_columns() {
            let xpt_col = series_to_column(col)?;
            columns.push(xpt_col);
        }

        Dataset::new(domain_code, columns)
    }
}

/// Converts xportrs `ColumnData` to a Polars Series.
fn column_data_to_series(name: &str, data: &ColumnData) -> Result<Series> {
    let series = match data {
        ColumnData::F64(values) => {
            let ca: Float64Chunked = values.iter().copied().collect();
            ca.with_name(name.into()).into_series()
        }
        ColumnData::I64(values) => {
            let ca: Int64Chunked = values.iter().copied().collect();
            ca.with_name(name.into()).into_series()
        }
        ColumnData::Bool(values) => {
            let ca: BooleanChunked = values.iter().copied().collect();
            ca.with_name(name.into()).into_series()
        }
        ColumnData::String(values) => {
            let ca: StringChunked = values.iter().map(|s| s.as_deref()).collect();
            ca.with_name(name.into()).into_series()
        }
        ColumnData::Bytes(values) => {
            // Convert bytes to hex strings for Polars representation
            let strings: Vec<Option<String>> = values
                .iter()
                .map(|opt| opt.as_ref().map(|b| bytes_to_hex(b)))
                .collect();
            let ca: StringChunked = strings
                .iter()
                .map(|s: &Option<String>| s.as_deref())
                .collect();
            ca.with_name(name.into()).into_series()
        }
        ColumnData::Date(values) => {
            // Convert NaiveDate to days since Unix epoch for Polars Date type
            let epoch = chrono::NaiveDate::from_ymd_opt(1970, 1, 1).unwrap();
            let days: Vec<Option<i32>> = values
                .iter()
                .map(|opt| {
                    opt.map(|d| {
                        let days = d.signed_duration_since(epoch).num_days();
                        days as i32
                    })
                })
                .collect();
            let ca: Int32Chunked = days.iter().copied().collect();
            ca.with_name(name.into())
                .cast(&DataType::Date)
                .map_err(|e: PolarsError| Error::Polars {
                    message: e.to_string(),
                })?
        }
        ColumnData::DateTime(values) => {
            // Convert NaiveDateTime to milliseconds since Unix epoch
            let millis: Vec<Option<i64>> = values
                .iter()
                .map(|opt| opt.map(|dt| dt.and_utc().timestamp_millis()))
                .collect();
            let ca: Int64Chunked = millis.iter().copied().collect();
            ca.with_name(name.into())
                .cast(&DataType::Datetime(TimeUnit::Milliseconds, None))
                .map_err(|e: PolarsError| Error::Polars {
                    message: e.to_string(),
                })?
        }
        ColumnData::Time(values) => {
            // Convert NaiveTime to nanoseconds since midnight
            let nanos: Vec<Option<i64>> = values
                .iter()
                .map(|opt| {
                    opt.map(|t| {
                        let secs = t.num_seconds_from_midnight() as i64;
                        let nano = t.nanosecond() as i64;
                        secs * 1_000_000_000 + nano
                    })
                })
                .collect();
            let ca: Int64Chunked = nanos.iter().copied().collect();
            ca.with_name(name.into())
                .cast(&DataType::Time)
                .map_err(|e: PolarsError| Error::Polars {
                    message: e.to_string(),
                })?
        }
    };

    Ok(series)
}

/// Convert bytes to hex string (simple implementation without external dependency).
fn bytes_to_hex(bytes: &[u8]) -> String {
    const HEX_CHARS: &[u8; 16] = b"0123456789abcdef";
    let mut hex = String::with_capacity(bytes.len() * 2);
    for &b in bytes {
        hex.push(HEX_CHARS[(b >> 4) as usize] as char);
        hex.push(HEX_CHARS[(b & 0x0f) as usize] as char);
    }
    hex
}

/// Converts a Polars Column to an xportrs Column.
fn series_to_column(column: &Column) -> Result<XptColumn> {
    let name = column.name().as_str();
    let series = column.as_materialized_series();
    let data = series_to_column_data(series)?;
    Ok(XptColumn::new(name, data))
}

/// Converts a Polars Series to xportrs `ColumnData`.
fn series_to_column_data(series: &Series) -> Result<ColumnData> {
    let dtype = series.dtype();

    match dtype {
        DataType::Float64 => {
            let ca = series.f64().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<f64>> = ca.into_iter().collect();
            Ok(ColumnData::F64(values))
        }
        DataType::Float32 => {
            let ca = series.f32().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<f64>> = ca.into_iter().map(|v| v.map(f64::from)).collect();
            Ok(ColumnData::F64(values))
        }
        DataType::Int64 => {
            let ca = series.i64().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<i64>> = ca.into_iter().collect();
            Ok(ColumnData::I64(values))
        }
        DataType::Int32 => {
            let ca = series.i32().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<i64>> = ca.into_iter().map(|v| v.map(i64::from)).collect();
            Ok(ColumnData::I64(values))
        }
        DataType::Int16 => {
            let ca = series.i16().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<i64>> = ca.into_iter().map(|v| v.map(i64::from)).collect();
            Ok(ColumnData::I64(values))
        }
        DataType::Int8 => {
            let ca = series.i8().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<i64>> = ca.into_iter().map(|v| v.map(i64::from)).collect();
            Ok(ColumnData::I64(values))
        }
        DataType::UInt64 => {
            let ca = series.u64().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            // Convert to i64, saturating at i64::MAX
            let values: Vec<Option<i64>> = ca
                .into_iter()
                .map(|v| v.map(|u| i64::try_from(u).unwrap_or(i64::MAX)))
                .collect();
            Ok(ColumnData::I64(values))
        }
        DataType::UInt32 => {
            let ca = series.u32().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<i64>> = ca.into_iter().map(|v| v.map(i64::from)).collect();
            Ok(ColumnData::I64(values))
        }
        DataType::UInt16 => {
            let ca = series.u16().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<i64>> = ca.into_iter().map(|v| v.map(i64::from)).collect();
            Ok(ColumnData::I64(values))
        }
        DataType::UInt8 => {
            let ca = series.u8().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<i64>> = ca.into_iter().map(|v| v.map(i64::from)).collect();
            Ok(ColumnData::I64(values))
        }
        DataType::Boolean => {
            let ca = series.bool().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<bool>> = ca.into_iter().collect();
            Ok(ColumnData::Bool(values))
        }
        DataType::String => {
            let ca = series.str().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<String>> = ca.into_iter().map(|v| v.map(String::from)).collect();
            Ok(ColumnData::String(values))
        }
        // For Date, DateTime, Time - convert to numeric values as the primary representation
        // These can be converted back when writing to XPT using the temporal utilities
        DataType::Date => {
            // Convert Date (days since epoch) to i64 for storage
            let casted = series.cast(&DataType::Int32).map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let ca = casted.i32().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<i64>> = ca.into_iter().map(|v| v.map(i64::from)).collect();
            Ok(ColumnData::I64(values))
        }
        DataType::Datetime(_, _) => {
            // Convert DateTime to i64 (milliseconds since epoch)
            let casted = series
                .cast(&DataType::Datetime(TimeUnit::Milliseconds, None))
                .map_err(|e| Error::Polars {
                    message: e.to_string(),
                })?;
            let ca = casted.i64().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<i64>> = ca.into_iter().collect();
            Ok(ColumnData::I64(values))
        }
        DataType::Time => {
            // Convert Time to i64 (nanoseconds since midnight)
            let casted = series.cast(&DataType::Int64).map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let ca = casted.i64().map_err(|e| Error::Polars {
                message: e.to_string(),
            })?;
            let values: Vec<Option<i64>> = ca.into_iter().collect();
            Ok(ColumnData::I64(values))
        }
        _ => Err(Error::Polars {
            message: format!("Unsupported Polars dtype for XPT conversion: {dtype}"),
        }),
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_dataset_to_dataframe() {
        let dataset = Dataset::new(
            "AE",
            vec![
                XptColumn::new(
                    "USUBJID",
                    ColumnData::String(vec![Some("01-001".into()), Some("01-002".into())]),
                ),
                XptColumn::new("AESEQ", ColumnData::I64(vec![Some(1), Some(2)])),
                XptColumn::new("AEVAL", ColumnData::F64(vec![Some(1.5), None])),
            ],
        )
        .unwrap();

        let df = dataset.into_dataframe().unwrap();
        assert_eq!(df.width(), 3);
        assert_eq!(df.height(), 2);
    }

    #[test]
    fn test_dataframe_to_dataset() {
        let s1 = Series::new("USUBJID".into(), &["01-001", "01-002"]);
        let s2 = Series::new("AESEQ".into(), &[1i64, 2i64]);

        let df = DataFrame::new(vec![s1.into(), s2.into()]).unwrap();

        let dataset = Dataset::from_dataframe("AE", df).unwrap();
        assert_eq!(dataset.domain_code(), "AE");
        assert_eq!(dataset.ncols(), 2);
        assert_eq!(dataset.nrows(), 2);
    }

    #[test]
    fn test_roundtrip() {
        let original = Dataset::new(
            "DM",
            vec![
                XptColumn::new("STUDYID", ColumnData::String(vec![Some("STUDY001".into())])),
                XptColumn::new("AGE", ColumnData::I64(vec![Some(45)])),
            ],
        )
        .unwrap();

        let df = original.clone().into_dataframe().unwrap();
        let roundtrip = Dataset::from_dataframe("DM", df).unwrap();

        assert_eq!(roundtrip.domain_code(), original.domain_code());
        assert_eq!(roundtrip.ncols(), original.ncols());
        assert_eq!(roundtrip.nrows(), original.nrows());
    }

    #[test]
    fn test_bytes_to_hex() {
        assert_eq!(bytes_to_hex(&[0x00, 0xff, 0xab]), "00ffab");
        assert_eq!(bytes_to_hex(&[]), "");
        assert_eq!(bytes_to_hex(&[0x12, 0x34]), "1234");
    }
}