estat_getStatsData {estatapi}

getStatsData API

Description

Get some statistical data via e-Stat API.

Usage

estat_getStatsData(
  appId,
  statsDataId,
  startPosition = NULL,
  limit = NULL,
  lang = c("J", "E"),
  .fetch_all = TRUE,
  ...
)

Arguments

appId

Application ID.

statsDataId

ID of the statistical dataset.

startPosition

Index of the first record to get.

limit

Max number of records to get.

lang

Language of the data. "J"(Japanese) or "E"(English).

.fetch_all

Whether to fetch all records when the number of records is larger than 100,000.

...

Other parameters.

• lvTab: Level of the meta-information. The format can be X or X-Y, -X and ⁠X-⁠.

• cdTab: Code(s) of the meta-infomation items to select. The format can be a character vector (c("001", "002")) or a chraracter of values and commas ("001,002").

• cdTabFrom: The code of the first meta-information item to select.

• cdTabTo: The code of the last meta-information item to select.

• lvTime: Level of the time to select. The format is the same as lvTab

• cdTime Time(s) to select. The format is the same way like cdTab

• cdTimeFrom: The first time to select. The format is the same way like cdTabFrom

• cdTimeTo: The last time to select. The format is the same way like cdTabTo

• lvArea: Level of the area to select. The format is the same as lvTab

• cdArea Code(s) of the Area to select. The format is the same way like cdTab

• cdAreaFrom: The code of the first area to select. The format is the same way like cdTabFrom

• cdAreaTo: The code of the last area to select. The format is the same way like cdTabTo

• lvCat01, cdCat01, cdCat01From, cdCat01To, ...: The same way like above.

See Also

http://www.e-stat.go.jp/api/e-stat-manual3-0/#api_2_3 http://www.e-stat.go.jp/api/e-stat-manual3-0/#api_3_4

Examples

## Not run: 
# fetch all data, which may take time
estat_getStatsData(
  appId = "XXXX",
  statsDataId = "0003065345"
)

# fetch data up to 10 records
estat_getStatsData(
  appId = "XXXX",
  statsDataId = "0003065345",
  limit = 10
)

# fetch data up to 100,000 records (max number of records available at once)
estat_getStatsData(
  appId = "XXXX",
  statsDataId = "0003065345",
  .fetch_all = FALSE
)

# fetch all data in the specifed category
estat_getStatsData(
  appId = "XXXX",
  statsDataId = "0003065345",
  cdCat01 = c("008", "009", "010")
)

## End(Not run)