rd-helpdb 0.0.1

Reader for installed R package help databases (aliases, .rdx/.rdb, Meta/hsearch.rds), built on rd-rds
Documentation
  • Coverage
  • 23.81%
    5 out of 21 items documented0 out of 0 items with examples
  • Size
  • Source code size: 98.37 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 528.26 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 8s Average build duration of successful builds.
  • all releases: 8s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Repository
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • eitsupi

rd-helpdb

rd-helpdb reads the compiled help database of an installed R package and provides alias, topic, and help-search access.

Overview

An installed package help database consists of help/aliases.rds, the help/<pkg>.rdx index and help/<pkg>.rdb record pair, and Meta/hsearch.rds. rd-helpdb reads the standalone RDS files and the compressed records addressed by the .rdx index; it does not discover package directories through R's .libPaths().

Standalone .rds envelope handling is delegated to rd-rds. Consumers that need a canonical document model can lower decoded help objects into rd-ast.

Stability

Alias, topic, and search reading for an explicitly named installed-package directory is supported. Discovering R libraries or packages on a machine is out of scope; see the workspace stability policy.

License

MIT; see the workspace license. See the workspace README for repository status and layout.