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

# Examples

Code examples demonstrating `xportrs` functionality.

## Running Examples

```bash
cargo run --example <name>
```

## Available Examples

| Example                           | Description                                     |
|-----------------------------------|-------------------------------------------------|
| [`read_simple`](read_simple.rs)   | Read an XPT file and access dataset information |
| [`write_simple`](write_simple.rs) | Create a dataset and write to XPT format        |
| [`write_fda`](write_fda.rs)       | Write with FDA compliance validation            |
| [`inspect`](inspect.rs)           | Inspect XPT metadata without loading full data  |
| [`roundtrip`](roundtrip.rs)       | Read, inspect, and write back to a new file     |

## Quick Reference

### Reading

```rust
use xportrs::Xpt;

fn main() -> Result<(), xportrs::Error> {
    let dataset = Xpt::read("path/to/file.xpt")?;
    println!("Rows: {}, Columns: {}", dataset.nrows(), dataset.ncols());
    Ok(())
}
```

### Writing

```rust
use xportrs::{Column, ColumnData, Dataset, Xpt};

fn main() -> Result<(), xportrs::Error> {
    let dataset = Dataset::new("DM", vec![
        Column::new("USUBJID", ColumnData::String(vec![Some("SUBJ-001".into())])),
        Column::new("AGE", ColumnData::I64(vec![Some(45)])),
    ])?;

    Xpt::writer(dataset).finalize()?.write_path("dm.xpt")?;
    Ok(())
}
```

### With Agency Validation

```rust
use xportrs::{Agency, Column, ColumnData, Dataset, Xpt};

fn main() -> Result<(), xportrs::Error> {
    let dataset = Dataset::new("DM", vec![
        Column::new("USUBJID", ColumnData::String(vec![Some("SUBJ-001".into())])),
    ])?;

    Xpt::writer(dataset)
        .agency(Agency::FDA)
        .finalize()?
        .write_path("dm.xpt")?;
    Ok(())
}
```

### Inspecting Metadata

```rust
use xportrs::Xpt;

fn main() -> Result<(), xportrs::Error> {
    let info = Xpt::inspect("file.xpt")?;
    println!("Members: {:?}", info.member_names());
    Ok(())
}
```

## More Information

See the [API documentation](https://docs.rs/xportrs) for complete reference.