Package 'govStatJPN'

Title: functions to get public survey data in Japan
Description: This package purposes to deal with public survey data of Japanese government via their Application Programming Interface (http://statdb.nstac.go.jp/)
Authors: Yuichiro Otani
Maintainer: Yuichiro Otani <[email protected]>
License: GPL
Version: 0.1
Built: 2025-02-14 03:40:00 UTC
Source: https://github.com/cran/govStatJPN

Help Index


Package to load public survey data by Japanese government offered via their Application Programming Interface (API).

Description

This package purposes to use the public data in simple way.
This product uses the Gateway to Advanced and User-friendly Statistics Service API but is not endorsed or certified by the Statistics Bureau or the National Statistics Center.

Details

Package: govStatJPN
Type: Package
Version: 0.1a
Date: 2013-06-11
License: Yuichiro Otani <[email protected]>
LazyLoad: yes

Author(s)

Yuichio Otani <[email protected]>

References

http://statdb.nstac.go.jp/
http://statdb.nstac.go.jp/wp/wp-content/uploads/2013/06/API-spec.pdf

See Also

get.stat.list, get.meta.info, get.stat.data

Examples

# library(govStatJPN)

Object to Get Meta Data of a Specified Survey.

Description

This function purposes to get a meta data API offers.

Usage

get.meta.info(app.id, stat.id)

Arguments

app.id

Your application ID. Using all functions contained govStatJPN package, this ID is required.
Registration page is https://statdb.nstac.go.jp/apiuser/php/index.php?action=provisional
Login page is https://statdb.nstac.go.jp/apiuser/php/index.php?action=login
After logging in, you are able to issue your application ID.

stat.id

Required. This is an id in retuned values of get.stat.list.

Details

This function is based on section 3.3 at the published pdf file (http://statdb.nstac.go.jp/wp/wp-content/uploads/2013/06/API-spec.pdf).

Value

A data frame object is returned.

Note

This product uses the Gateway to Advanced and User-friendly Statistics Service API but is not endorsed or certified by the Statistics Bureau or the National Statistics Center.

Author(s)

Yuichio Otani <[email protected]>

References

http://statdb.nstac.go.jp/
http://statdb.nstac.go.jp/wp/wp-content/uploads/2013/06/API-spec.pdf

See Also

get.stat.list, get.stat.data

Examples

# app.id <- 'your application ID'
	# stat.list <- get.stat.list(app.id, list(surveyYears=2007, lang='J'))
	# meta.info <- get.meta.info(app.id, stat.list$id[1])
	# meta.info

Object to Get Statistical Data of a Specified Survey.

Description

This function purposes to get a data of a survey the defined with stat id.

Usage

get.stat.data(app.id, param, stat.id)

Arguments

app.id

Your application ID. Using all functions contained govStatJPN package, this ID is required.
Registration page is https://statdb.nstac.go.jp/apiuser/php/index.php?action=provisional
Login page is https://statdb.nstac.go.jp/apiuser/php/index.php?action=login
After logging in, you are able to issue your application ID.

param

You can set the list of survey years and language as a list object like list(limit=100, lang="J").
The default value of limit is 10.
When you need data set in English. Define lang="E" instead of lang="J".
Although setting other parameters is allowed in the API, the parameters that can be used in this function is limited into these two types. The number of parameters can be set in this function will be extended in the future.

stat.id

Required. This is an id in retuned values of get.stat.list.

Details

This function is based on section 3.4 at the published pdf file (http://statdb.nstac.go.jp/wp/wp-content/uploads/2013/06/API-spec.pdf).

Value

value

This is the data of the specified survey.

note

This is the note of the specified survey.

Note

This product uses the Gateway to Advanced and User-friendly Statistics Service API but is not endorsed or certified by the Statistics Bureau or the National Statistics Center.

Author(s)

Yuichio Otani <[email protected]>

References

http://statdb.nstac.go.jp/
http://statdb.nstac.go.jp/wp/wp-content/uploads/2013/06/API-spec.pdf

See Also

get.stat.list, get.meta.info

Examples

# stat.list <- get.stat.list(app.id, list(surveyYears=2007, lang='J'))
# stat.data <- get.stat.data(app.id, list(limit=100),stat.list$id[1])
# show data of the survey
# stat.data$value
# summation of data
# sum(stat.data$value$value)
# mean of data
# mean(stat.data$value$value)
# standard deviation of data
# sd(stat.data$value$value)

# get histogram
# hist(stat.data$value$value, breaks=25)

Object to Get a List of Survey.

Description

This object works to get a list of surveys.

Usage

get.stat.list(app.id, param)

Arguments

app.id

Your application ID. Using all functions contained govStatJPN package, this ID is required.
Registration page is https://statdb.nstac.go.jp/apiuser/php/index.php?action=provisional
Login page is https://statdb.nstac.go.jp/apiuser/php/index.php?action=login
After logging in, you are able to issue your application ID.

param

You can set the list of survey years and language as a list object like list(surveyYears=2012, lang="J").
If survey year is not defined, this year's survey list will return.
When you need data set in English. Define lang="E" instead of lang="J".
Although setting other parameters is allowed in the API, the parameters that can be used in this function is limited into these two types. The number of parameters can be set in this function will be extended in the future.

Details

This function is based on section 3.2 at the published pdf file (http://statdb.nstac.go.jp/wp/wp-content/uploads/2013/06/API-spec.pdf).

Value

id

This is a stat id of the survey. This object will be used in other functions in this package. The meanings of other values are provided in the reference(Japanese).

Note

This product uses the Gateway to Advanced and User-friendly Statistics Service API but is not endorsed or certified by the Statistics Bureau or the National Statistics Center.

Author(s)

Yuichio Otani <[email protected]>

References

http://statdb.nstac.go.jp/
http://statdb.nstac.go.jp/wp/wp-content/uploads/2013/06/API-spec.pdf

See Also

get.meta.info, get.stat.data

Examples

# app.id <- 'your application ID'
# stat.list <- get.stat.list(app.id, list(surveyYears=2007, lang='J'))
# stat.list