jared
24e67791a0
Adds full @description, @details (algorithm), @examples on cog_gov_search(); examples on cog_basket_resolution() / cog_basket_unresolved(); NEWS.md entry covering the new mode and the pattern->name rename; pkgdown reference entries for the two new exports.
36 lines
1.1 KiB
R
36 lines
1.1 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/basket.R
|
|
\name{cog_basket_resolution}
|
|
\alias{cog_basket_resolution}
|
|
\title{Inspect basket-mode resolution sidecar}
|
|
\usage{
|
|
cog_basket_resolution(x, expand_candidates = FALSE)
|
|
}
|
|
\arguments{
|
|
\item{x}{A tibble returned by basket-mode [cog_gov_search()].}
|
|
|
|
\item{expand_candidates}{Logical. If `TRUE`, keeps the `candidates`
|
|
list-column (full-schema match candidates per input row). Default
|
|
`FALSE`.}
|
|
}
|
|
\value{
|
|
A tibble with the resolution audit trail.
|
|
}
|
|
\description{
|
|
Returns the resolution tibble attached to a basket-mode result of
|
|
[cog_gov_search()]. One row per input entry; `status` is one of
|
|
`"resolved"`, `"largest_pop"`, `"ambiguous"`, `"no_match"`. By default
|
|
the `candidates` list-column is dropped for readable printing; pass
|
|
`expand_candidates = TRUE` to keep it.
|
|
}
|
|
\examples{
|
|
\dontrun{
|
|
basket <- cog_gov_search(
|
|
name = c("Broward", "San Diego", "Notarealplace"),
|
|
state = c("FL", "CA", "NY")
|
|
)
|
|
cog_basket_resolution(basket)
|
|
cog_basket_resolution(basket, expand_candidates = TRUE)
|
|
}
|
|
}
|