% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/dashboardapi-package.R
\docType{package}
\name{dashboardapi-package}
\alias{dashboardapi}
\alias{dashboardapi-package}
\title{dashboardapi: Japan's Statistics Dashboard data for R}
\description{
\code{dashboardapi} is an unofficial, independently developed client for the
Statistics Dashboard Web API provided by the Statistics Bureau of Japan.
It is not affiliated with, endorsed by, or maintained by the Statistics
Bureau. A typical workflow is:
}
\details{
\enumerate{
\item Find a series with \code{\link[=dashboard_search]{dashboard_search()}}.
\item Find region codes with \code{\link[=dashboard_regions]{dashboard_regions()}}.
\item Retrieve observations with \code{\link[=dashboard_data]{dashboard_data()}}.
}

No registration or API key is required. The API documentation asks clients
not to create a large volume of access in a short period. When
\code{\link[=dashboard_data]{dashboard_data()}} must split a request into multiple API calls, the package
therefore waits at least one second between calls.
}
\section{Package options}{

\itemize{
\item \code{dashboardapi.lang}: default response language, \code{"en"} or \code{"jp"}.
\item \code{dashboardapi.wait}: seconds between automatically batched requests;
default and enforced minimum \code{1}.
\item \code{dashboardapi.timeout}: request timeout in seconds; default \code{30}.
\item \code{dashboardapi.retries}: retries for transient failures; default \code{3}.
}
}

\section{Terms of use}{

When publishing content retrieved with this package, cite the Statistics
Dashboard as the source. When publishing edited content, also identify the
editing entity. Services published using the API should show the credit
requested by the Statistics Dashboard. Call \code{\link[=dashboard_api_credit]{dashboard_api_credit()}} for
the source citation, edited-content template, API credit, and official
links. The package's MIT license applies only to original package code and
documentation; it does not relicense government or third-party data,
metadata, or official texts. Check any individual rights statement before
reusing third-party content.
}

\seealso{
\href{https://dashboard.e-stat.go.jp/en/static/api}{Statistics Dashboard API}
}
\author{
\strong{Maintainer}: Kenji Miyazaki \email{kenjimyzk@gmail.com}

Authors:
\itemize{
  \item Kenji Miyazaki \email{kenjimyzk@gmail.com}
}

}
\keyword{internal}
