#lossless #rfc822 #edit #r

r-description

Parsing and editor for R DESCRIPTION files

8 releases

0.3.1 Nov 3, 2024
0.3.0 Nov 3, 2024
0.2.2 Oct 9, 2024
0.1.2 Sep 25, 2024
0.1.0 Aug 28, 2024

#808 in Parser implementations

Download history 430/week @ 2024-12-04 439/week @ 2024-12-11 451/week @ 2024-12-18 302/week @ 2024-12-25 475/week @ 2025-01-01 284/week @ 2025-01-08 258/week @ 2025-01-15 230/week @ 2025-01-22 249/week @ 2025-01-29 1667/week @ 2025-02-05 3705/week @ 2025-02-12 836/week @ 2025-02-19 2429/week @ 2025-02-26 3127/week @ 2025-03-05 4813/week @ 2025-03-12 1296/week @ 2025-03-19

11,712 downloads per month
Used in 2 crates

Apache-2.0

93KB
2K SLoC

R DESCRIPTION parser

This crate provides a parser and editor for the DESCRIPTION files used in R packages.

See https://r-pkgs.org/description.html and https://cran.r-project.org/doc/manuals/R-exts.html for more information on the format.

Besides parsing the control files it also supports parsing and comparison of version strings according to the R package versioning scheme as well as relations between versions.

Example


use std::str::FromStr;
use r_description::lossy::RDescription;

let mut desc = RDescription::from_str(r###"Package: foo
Version: 1.0
Depends: R (>= 3.0.0)
Description: A foo package
Title: A foo package
License: GPL-3
"###).unwrap();

assert_eq!(desc.name, "foo");
assert_eq!(desc.version, "1.0".parse().unwrap());
assert_eq!(desc.depends, Some("R (>= 3.0.0)".parse().unwrap()));

desc.license = "MIT".to_string();
use r_description::Version;

let v1: Version = "1.2.3-alpha".parse().unwrap();
let v2: Version = "1.2.3".parse().unwrap();
assert!(v1 < v2);

use std::str::FromStr;
use r_description::lossy::Relations;

let v1 = r_description::Version::from_str("1.2.3").unwrap();
let rels: Relations = "cli (>= 2.0), crayon (= 1.3.4), testthat".parse().unwrap();
assert_eq!(3, rels.len());
assert_eq!(rels[0].name, "cli");

Dependencies

~5.5–7.5MB
~126K SLoC