getRdTitle: Extract Title from an Rd Object

View source: R/listPackageFunctions.R

getRdTitleR Documentation

Extract Title from an Rd Object

Description

This internal helper function traverses an Rd object to extract the text from the \title field. It is used by listPackageFunctions to obtain a concise description for each documented function.

Usage

getRdTitle(rd)

Arguments

rd

An Rd object typically obtained via function like utils:::.getHelpFile.

Value

A character string containing the title extracted from the Rd object. If the title is not found, an empty string is returned.


ices-tools-dev/icesRDBES documentation built on April 17, 2025, 1:58 p.m.