examples_from_dir: Build logical vector for Rd objects with example or usage...

View source: R/pkg_ref_cache_examples.R

examples_from_dirR Documentation

Build logical vector for Rd objects with example or usage fields discovered in a given directory

Description

Build logical vector for Rd objects with example or usage fields discovered in a given directory

Usage

examples_from_dir(path, pkg)

Arguments

path

a package directory path expected to contain exported objects

Value

a numeric proportion of documentation files with examples


riskmetric documentation built on Sept. 1, 2023, 1:06 a.m.