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.
30 lines
829 B
R
30 lines
829 B
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/basket.R
|
|
\name{cog_basket_unresolved}
|
|
\alias{cog_basket_unresolved}
|
|
\title{Filter a basket resolution to unresolved rows}
|
|
\usage{
|
|
cog_basket_unresolved(x)
|
|
}
|
|
\arguments{
|
|
\item{x}{A tibble returned by basket-mode [cog_gov_search()].}
|
|
}
|
|
\value{
|
|
A tibble (subset of [cog_basket_resolution()]).
|
|
}
|
|
\description{
|
|
Convenience wrapper that returns just the rows where `status` is
|
|
`"ambiguous"` or `"no_match"` — the ones the user likely wants to
|
|
refine before piping into a query verb. The `candidates` list-column
|
|
is preserved so the user can drill into ambiguous match sets.
|
|
}
|
|
\examples{
|
|
\dontrun{
|
|
basket <- cog_gov_search(
|
|
name = c("Broward", "San Diego", "Notarealplace"),
|
|
state = c("FL", "CA", "NY")
|
|
)
|
|
cog_basket_unresolved(basket)
|
|
}
|
|
}
|