docs: roxygen, NEWS, and pkgdown for basket mode

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.
This commit is contained in:
2026-04-28 12:51:52 -04:00
parent 7475696853
commit 24e67791a0
7 changed files with 211 additions and 32 deletions
+10
View File
@@ -23,3 +23,13 @@ Returns the resolution tibble attached to a basket-mode result of
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)
}
}