jared
68b72faeae
Pre-rename in preparation for basket mode. All existing callers in this package and cog_explorer/ pass the first argument positionally, so this rename is non-breaking. No deprecation alias added per design spec (no external consumers; package is pre-release v0.1.0). @param roxygen also updated to match the new formal; man/cog_gov_search.Rd regenerated via devtools::document().
31 lines
1.1 KiB
R
31 lines
1.1 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/search.R
|
|
\name{cog_gov_search}
|
|
\alias{cog_gov_search}
|
|
\title{Search for governments by name, state, and/or type}
|
|
\usage{
|
|
cog_gov_search(name = NULL, state = NULL, type = NULL)
|
|
}
|
|
\arguments{
|
|
\item{name}{Character regex matched case-insensitively against
|
|
`gov_name`. `NULL` (default) means no name filter.}
|
|
|
|
\item{state}{Either a 2-letter USPS abbreviation (e.g. `"FL"`), a FIPS
|
|
integer (e.g. `12`), or `NULL`.}
|
|
|
|
\item{type}{Government type: an integer in `0:3` or one of `"state"`,
|
|
`"county"`, `"city"`, `"township"`. Passing `4`, `5`,
|
|
`"special_district"`, or `"school_district"` emits an explanatory
|
|
message and returns an empty tibble (v0.1 corpus excludes those types).}
|
|
}
|
|
\value{
|
|
Tibble from `canonical_fips_xwalk` sorted by `population_acs`
|
|
descending (`NULL`s last).
|
|
}
|
|
\description{
|
|
Returns rows from `canonical_fips_xwalk` matching the supplied filters.
|
|
Intended as the entry point users call to resolve a human-readable place
|
|
name into one or more `canonical_govid` values before calling
|
|
[cog_spending()] / [cog_revenue()] / etc.
|
|
}
|