From d8e90eacc6db4f70df12abaa1363967fa2e58068 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A5ns=20Magnusson?= Date: Sat, 29 Nov 2014 11:47:03 +0100 Subject: [PATCH] Small update in vignette and ordering of apis --- inst/doc/pxweb.Rmd | 4 +++- inst/doc/pxweb.html | 29 ++++++++++++------------ inst/doc/pxweb.md | 30 +++++++++++++------------ inst/extdata/api.json | 52 +++++++++++++++++++++---------------------- vignettes/pxweb.Rmd | 2 +- 5 files changed, 61 insertions(+), 56 deletions(-) diff --git a/inst/doc/pxweb.Rmd b/inst/doc/pxweb.Rmd index e63b727f..ecc3269d 100644 --- a/inst/doc/pxweb.Rmd +++ b/inst/doc/pxweb.Rmd @@ -72,9 +72,11 @@ Some examples on using the R tools to fetch px-web API data. ### Listing available pxweb apis +To list the available apis in the package, use `api_catalogue()`. + ```{r apiparameters, message=FALSE, eval=TRUE} library(pxweb) -print(api_catalogue()[1:2]) +api_catalogue()[1:2] ``` ### Fetching data from PX-WEB API: diff --git a/inst/doc/pxweb.html b/inst/doc/pxweb.html index 67e72b27..dab2d29f 100644 --- a/inst/doc/pxweb.html +++ b/inst/doc/pxweb.html @@ -95,27 +95,28 @@

Examples

Some examples on using the R tools to fetch px-web API data.

Listing available pxweb apis

+

To list the available apis in the package, use api_catalogue().

library(pxweb)
-print(api_catalogue()[1:2])
+api_catalogue()[1:2] 
## [[1]]
-## Api: statistik.sjv.se 
-##      The Swedish agricultural authority 
+## Api: api.scb.se ('scb')
+##      Statistics Sweden 
 ## Version(s)   : v1 
-## Language(s)  : sv 
-## Limit(s)     : 10 calls per 10 sec.
-##                1000  values per call.
+## Language(s)  : en, sv 
+## Limit(s)     : 30 calls per 10 sec.
+##                1e+05  values per call.
 ## Url template :
-##  http://statistik.sjv.se/PXWeb/api/[version]/[lang] 
+##  http://api.scb.se/OV0104/[version]/doris/[lang] 
 ## 
 ## [[2]]
-## Api: pxweb.orebro.se 
-##      Open data from the municipality Orebro in Sweden. 
+## Api: pxnet2.stat.fi ('statfi')
+##      Statistics Finland 
 ## Version(s)   : v1 
-## Language(s)  : sv 
-## Limit(s)     : 10 calls per 10 sec.
-##                1000  values per call.
+## Language(s)  : fi 
+## Limit(s)     : 30 calls per 10 sec.
+##                1e+05  values per call.
 ## Url template :
-##  http://pxweb.orebro.se/api/[version]/[lang]
+## http://pxnet2.stat.fi/PXWeb/api/[version]/[lang]

Fetching data from PX-WEB API:

@@ -188,7 +189,7 @@

Session info

## [1] stats graphics grDevices utils datasets methods base ## ## other attached packages: -## [1] pxweb_0.5.0 +## [1] pxweb_0.5.3 ## ## loaded via a namespace (and not attached): ## [1] data.table_1.9.2 digest_0.6.4 evaluate_0.5.5 formatR_0.10 diff --git a/inst/doc/pxweb.md b/inst/doc/pxweb.md index df88ed0f..f3fae84b 100644 --- a/inst/doc/pxweb.md +++ b/inst/doc/pxweb.md @@ -71,32 +71,34 @@ Some examples on using the R tools to fetch px-web API data. ### Listing available pxweb apis +To list the available apis in the package, use `api_catalogue()`. + ```r library(pxweb) -print(api_catalogue()[1:2]) +api_catalogue()[1:2] ``` ``` ## [[1]] -## Api: statistik.sjv.se -## The Swedish agricultural authority +## Api: api.scb.se ('scb') +## Statistics Sweden ## Version(s) : v1 -## Language(s) : sv -## Limit(s) : 10 calls per 10 sec. -## 1000 values per call. +## Language(s) : en, sv +## Limit(s) : 30 calls per 10 sec. +## 1e+05 values per call. ## Url template : -## http://statistik.sjv.se/PXWeb/api/[version]/[lang] +## http://api.scb.se/OV0104/[version]/doris/[lang] ## ## [[2]] -## Api: pxweb.orebro.se -## Open data from the municipality Orebro in Sweden. +## Api: pxnet2.stat.fi ('statfi') +## Statistics Finland ## Version(s) : v1 -## Language(s) : sv -## Limit(s) : 10 calls per 10 sec. -## 1000 values per call. +## Language(s) : fi +## Limit(s) : 30 calls per 10 sec. +## 1e+05 values per call. ## Url template : -## http://pxweb.orebro.se/api/[version]/[lang] +## http://pxnet2.stat.fi/PXWeb/api/[version]/[lang] ``` ### Fetching data from PX-WEB API: @@ -198,7 +200,7 @@ sessionInfo() ## [1] stats graphics grDevices utils datasets methods base ## ## other attached packages: -## [1] pxweb_0.5.0 +## [1] pxweb_0.5.3 ## ## loaded via a namespace (and not attached): ## [1] data.table_1.9.2 digest_0.6.4 evaluate_0.5.5 formatR_0.10 diff --git a/inst/extdata/api.json b/inst/extdata/api.json index 8f6c9cf6..d6d15a34 100644 --- a/inst/extdata/api.json +++ b/inst/extdata/api.json @@ -1,25 +1,15 @@ { "apis": { - "statistik.sjv.se": { - "alias" : ["jordbruksverket"], - "description" : "The Swedish agricultural authority", - "url" : "http://statistik.sjv.se/PXWeb/api/[version]/[lang]", - "version": ["v1"], - "lang": ["sv"], - "calls_per_period": 10, - "period_in_seconds": 10, - "max_values_to_download" : 1000 - }, - - "pxweb.orebro.se": { - "description" : "Open data from the municipality Orebro in Sweden.", - "url" : "http://pxweb.orebro.se/api/[version]/[lang]", + "api.scb.se": { + "alias" : ["scb"], + "description" : "Statistics Sweden", + "url" : "http://api.scb.se/OV0104/[version]/doris/[lang]", "version": ["v1"], - "lang": ["sv"], - "calls_per_period": 10, + "lang": ["en", "sv"], + "calls_per_period": 30, "period_in_seconds": 10, - "max_values_to_download" : 1000 - }, + "max_values_to_download" : 100000 + }, "pxnet2.stat.fi": { "alias" : ["statfi"], @@ -42,16 +32,26 @@ "max_values_to_download" : 100000 }, - "api.scb.se": { - "alias" : ["scb"], - "description" : "Statistics Sweden", - "url" : "http://api.scb.se/OV0104/[version]/doris/[lang]", + "statistik.sjv.se": { + "alias" : ["jordbruksverket"], + "description" : "The Swedish agricultural authority", + "url" : "http://statistik.sjv.se/PXWeb/api/[version]/[lang]", "version": ["v1"], - "lang": ["en", "sv"], - "calls_per_period": 30, + "lang": ["sv"], + "calls_per_period": 10, "period_in_seconds": 10, - "max_values_to_download" : 100000 - } + "max_values_to_download" : 1000 + }, + + "pxweb.orebro.se": { + "description" : "Open data from the municipality Orebro in Sweden.", + "url" : "http://pxweb.orebro.se/api/[version]/[lang]", + "version": ["v1"], + "lang": ["sv"], + "calls_per_period": 10, + "period_in_seconds": 10, + "max_values_to_download" : 1000 + } }, "local_apis": {} diff --git a/vignettes/pxweb.Rmd b/vignettes/pxweb.Rmd index f3ef83ba..05c15e54 100644 --- a/vignettes/pxweb.Rmd +++ b/vignettes/pxweb.Rmd @@ -60,7 +60,7 @@ Some examples on using the R tools to fetch px-web API data. ```{r apiparameters, message=FALSE, eval=TRUE} library(pxweb) -print(api_catalogue()[1:2]) +api_catalogue() ``` ### Fetching data from PX-WEB API: