govStatJPN (version 0.1)

get.stat.list: 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.

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).

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).

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