qtbi_help: Package help index for qtbi

In qtbi: Quantum Toxic Burden Index

Package help index for qtbi

Description

Prints a topic index for the main qtbi functions and optionally opens documentation for a specific topic. Use this when you want a guided entry point to the package; standard R help remains available via ?function_name and help(package = "qtbi").

Usage

qtbi_help(topic = NULL)

Arguments

topic

Optional character string naming a function or topic to open. If omitted, a summary index is printed.

Value

Invisibly returns NULL. When topic is supplied, the corresponding help page is opened as a side effect.

Examples

qtbi_help()
qtbi_help("estimate_qtbi")

qtbi documentation built on June 9, 2026, 5:09 p.m.