rd-helpdb 0.5.0

Reader for installed R package help databases (aliases, .rdx/.rdb, Meta/hsearch.rds), built on rd-rds
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

//! Reader for installed R package help databases (aliases, `.rdx`/`.rdb`,
//! topic metadata, typed help-search, vignette, and demo indexes), built on
//! top of `rd-rds`.
//!
//! An installed package directory looks like:
//!
//! ```text
//! <pkg_dir>/help/<pkg>.rdx       # RDS file: index
//! <pkg_dir>/help/<pkg>.rdb       # concatenated binary records
//! <pkg_dir>/help/aliases.rds     # RDS: named character vector alias -> topic
//! <pkg_dir>/Meta/Rd.rds          # RDS: topic metadata, independent of help files
//! <pkg_dir>/Meta/hsearch.rds     # RDS: help-search index
//! <pkg_dir>/Meta/vignette.rds    # optional RDS: vignette data frame
//! <pkg_dir>/Meta/demo.rds        # optional RDS: two-column demo matrix
//! ```
//!
//! `rd-helpdb` does not discover installed packages (R's `.libPaths()`
//! logic is out of scope): [`PackageHelpDb::open`] takes an explicit
//! package directory.
//! [`HelpTopicIndex::read_installed`] reads topic metadata without requiring
//! the compiled help database, allowing consumers to retain title-only help.
//! [`HelpSearchIndex::read_installed`] likewise reads the four typed
//! `Meta/hsearch.rds` matrices without opening compiled help.

mod db;
pub mod demo;
mod error;
mod rds;
pub mod search;
pub mod topics;
mod util;
pub mod vignette;

pub use db::PackageHelpDb;
pub use demo::{DemoEntry, DemoIndex};
pub use error::Error;
pub use rds::{decode_rdb_record, read_rds_file};
pub use search::{
    HelpSearchAliasEntry, HelpSearchBaseEntry, HelpSearchConceptEntry, HelpSearchIndex,
    HelpSearchKeywordEntry,
};
pub use topics::{HelpTopicEntry, HelpTopicIndex, HelpTopicText};
pub use vignette::{VignetteEntry, VignetteIndex};