Package 'rstatscn'

Title: R Interface for China National Data
Description: R interface for china national data <http://data.stats.gov.cn/>, some convenient functions for accessing the national data are provided.
Authors: Xuehui YANG
Maintainer: Xuehui YANG <[email protected]>
License: Apache License 2.0
Version: 1.1.3
Built: 2025-03-10 05:04:45 UTC
Source: https://github.com/jiang-hang/rstatscn

Help Index


private function for check the http status

Description

private function for check the http status

Usage

checkHttpStatus(ret)

Arguments

ret

the response obj returned by httr package

Value

return nothing , but if it finds some error , it stop the script


private function to convert the returned jason data to a dataframe

Description

private function to convert the returned jason data to a dataframe

Usage

dataJson2df(rawObj, rowcode, colcode)

Arguments

rawObj

the fromJSON output

rowcode

rowcode in the data frame

colcode

colcode in the data frame

Value

the contructed data frame


private function for constructing the query parameter for dfwds

Description

private function for constructing the query parameter for dfwds

Usage

genDfwds(wdcode, valuecode)

Arguments

wdcode

string value , one of c("zb","sj","reg")

valuecode

string value , following is the table for available valuecode zb: the valudecode can be gotten by statscnQueryZb() function sj: the valudecode can be "2014" for nd db, "2014C" for jd db. reg: the valudecode is the region code fetched by statscnRegions(dbcode) function

Value

return the queyr string for the http request


private function for sec

Description

private function for sec

Usage

milSec()

Value

milsec


the available dbs

Description

the available dbs in the national db

Usage

statscnDbs()

Value

a data frame with 2 columns , one is the dbcode, another is the db description

Examples

statscnDbs()

query data in the statscn db

Description

the main function for querying the statscn database, it will retrieve the data from specified db and orginize the data in a data frame.

Usage

statscnQueryData(zb = "A0201", dbcode = "hgnd", rowcode = "zb",
  colcode = "sj", moreWd = list(name = NA, value = NA))

Arguments

zb

the zb/category code to be queried

dbcode

the db code for querying

rowcode

rowcode in the returned data frame

colcode

colcode in the returned data frame

moreWd

more constraint on the data where the name should be one of c("reg","sj") , which stand for region and sj/time. the valuecode for reg should be the region code queried by statscnRegions() the valuecode for sj should be like '2014' for *nd , '2014C' for *jd , '201405' for *yd. Be noted that , the moreWd name should be different with either rowcode or colcode

Value

the data frame you are quering

Examples

## Not run: 
df=statscnQueryData('A0201',dbcode='hgnd')
df=statscnQueryData('A0201',dbcode='fsnd',rowcode='zb',colcode='sj',
                    moreWd=list(name='reg',value='110000'))

## End(Not run)

fetch the lastN data

Description

fetch the lastN data for the latest query, only affect the number of rows in the returned data. This function can not be used alone , statscnQueryData() has to be called before this function

Usage

statscnQueryLastN(n)

Arguments

n

the number of rows to be fetched

Value

the last n rows data in the latest query

Examples

## Not run: 
df=statscnQueryData('A0201',dbcode='hgnd')
df2=statscnQueryLastN(20)

## End(Not run)

the data categories

Description

the sub data categories for the zbid category, dbcode need to be specified, where the dbcode can be fetched by function statscnDbs(). In the returned data frame, the column 'isParent' shows if each sub category is leap category or not

Usage

statscnQueryZb(zbid = "zb", dbcode = "hgnd")

Arguments

zbid

the father zb/category id , the root id is 'zb'

dbcode

which db will be queried

Value

the data frame with the sub zbs/categories , if the given zbid is not a Parent zb/category, null list is returned

Examples

## Not run: 
 statscnQueryZb()
 statscnQueryZb('A01',dbcode="hgnd")

## End(Not run)

the regions in db

Description

the available regions in the specified db, it is used for query the province, city and country code generally

Usage

statscnRegions(dbcode = "fsnd")

Arguments

dbcode

the dbcode should be some province db(fs*) , city db(cs*) or internaltional db(gj*)

Value

the data frame with all the available region codes and names in the db

Examples

## Not run: 
 statscnRegions('fsnd')
 statscnRegions('csnd')
 statscnRegions('gjnd')

## End(Not run)

statscnRowNamePrefix

Description

set the rowName prefix in the dataframe

Usage

statscnRowNamePrefix(p = "nrow")

Arguments

p

, how to set the rowname prefix. it is 'nrow' by default , and it is the only supported value currently to unset the row name prefix, call this function with p=NULL

Details

in case you encounter the following error: Error in 'row.names<-.data.frame'('*tmp*', value = value) : duplicate 'row.names' are not allowed you need to call this function

Value

no return