% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/documentation_metrics.R
\name{assess_examples}
\alias{assess_examples}
\title{Assess Rd files for examples (exported functions only)}
\usage{
assess_examples(pkg_name, pkg_source_path)
}
\arguments{
\item{pkg_name}{Character scalar; package name (must be loadable so exports can be read).}

\item{pkg_source_path}{Directory path where Rd files can be found by `tools::Rd_db()`.}
}
\value{
A list with:
\describe{
  \item{data}{A data.frame with columns `function_name`, `documentation_name`,
              `documentation_location`, and `example`.}
  \item{example_score}{Numeric; percentage of exported functions with examples.}
}
}
\description{
Scans the package Rd database at `pkg_source_path` and reports whether each
**exported function** has examples. Resolution supports shared topics via
roxygen `@rdname` (multiple functions documented on the same Rd page) and
multiple `\\alias{}` entries.
}
\examples{
\dontrun{
  res <- assess_examples("stringr", "<path-to-stringr-source>")
  head(res$data)
  res$example_score
}
}
\keyword{internal}
