% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stations.R
\name{inmet_stations}
\alias{inmet_stations}
\title{List INMET automatic weather stations}
\usage{
inmet_stations(region = NULL, state = NULL, search = NULL)
}
\arguments{
\item{region}{Character vector. Filter by macro-region code(s):
\code{"CO"}, \code{"N"}, \code{"NE"}, \code{"S"}, \code{"SE"}. Case-insensitive.
If \code{NULL} (default), all regions are returned.}

\item{state}{Character vector. Filter by two-letter state abbreviation(s)
(e.g., \code{"RS"}, \code{"SP"}, \code{"AM"}). Case-insensitive.
If \code{NULL} (default), all states are returned.}

\item{search}{Character. A free-text search string applied to the station
name column (case-insensitive, partial matching). If \code{NULL} (default),
no name filtering is applied.}
}
\value{
A \code{data.frame} with columns:
\describe{
\item{\code{station_code}}{Character. INMET four-character station identifier.}
\item{\code{station_name}}{Character. Station name.}
\item{\code{region}}{Character. Macro-region code.}
\item{\code{state}}{Character. Two-letter state abbreviation.}
\item{\code{latitude}}{Numeric. Decimal degrees (negative = south).}
\item{\code{longitude}}{Numeric. Decimal degrees (negative = west).}
\item{\code{elevation}}{Numeric. Altitude in metres.}
\item{\code{start_year}}{Integer. Year from which data is available.}
}
}
\description{
Returns a \code{data.frame} of all INMET automatic weather stations (\emph{estações
automáticas}) with their metadata. The catalogue is bundled with the package
and reflects the stations as of the package release date.
}
\examples{
# All stations
st <- inmet_stations()
nrow(st)

# Stations in Rio Grande do Sul
st_rs <- inmet_stations(state = "RS")

# Search by name
inmet_stations(search = "porto alegre")

}
\seealso{
\code{\link[=inmet_download]{inmet_download()}}, \code{\link[=inmet_read]{inmet_read()}}
}
