1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
|
#' @name SDMXServiceProvider
#' @rdname SDMXServiceProvider
#' @aliases SDMXServiceProvider,SDMXServiceProvider-method
#'
#' @usage
#' SDMXServiceProvider(agencyId, name, scale, country, builder)
#'
#' @param agencyId an object of class "character" giving the a provider identifier
#' @param name an object of class "character" giving the name of the provider
#' @param scale an object of class "character" giving the scale of the datasource,
#' either "international" or "national". Default value is "international".
#' @param country an object of class "character" giving the ISO 3-alpha code of
#' the country (if scale is "national"). Default value is \code{NA}
#' @param builder an object of class "SDMXRequestBuilder" that will performs the
#' web request building for this specific provider
#' @return an object of class "SDMXServiceProvider"
#'
#' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
#'
#' @examples
#' #let's create a SDMXRESTRequestBuilder
#' #(assuming that "My Organization" implements SDMX REST web-services)
#' myBuilder <- SDMXREST20RequestBuilder(regUrl = "http://www.myorg.org/registry",
#' repoUrl = "http://www.myorg.org/repository",
#' compliant = TRUE)
#'
#' #create a SDMXServiceProvider
#' provider <- SDMXServiceProvider(agencyId = "MYORG", name = "My Organization",
#' builder = myBuilder)
#'
#' @export
#'
SDMXServiceProvider <- function(agencyId, name,
scale = "international", country = as.character(NA),
builder) {
new("SDMXServiceProvider",
agencyId = agencyId,
name = name,
scale = scale,
country = country,
builder = builder);
}
#other non-S4 methods
#====================
#' @name setSDMXServiceProviders
#' @aliases setSDMXServiceProviders
#' @title setSDMXServiceProviders
#'
#' @description function used internally by \pkg{rsdmx}, when loading the package,
#' to set the list of \link{SDMXServiceProvider} known by \pkg{rsdmx}
#' (hence known by \link{readSDMX} to query data/metadata in an easier
#' way). For internal use only (this function does not provide any
#' value for the end user, but it is here documented for transparency,
#' and to explain how the package works.)
#'
#' @usage
#' setSDMXServiceProviders()
#'
#' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
#'
#' @seealso \link{getSDMXServiceProviders} \link{addSDMXServiceProvider}
#' \link{findSDMXServiceProvider} \link{readSDMX}
#' @export
#'
setSDMXServiceProviders <- function(){ # nocov start
#international data providers
#----------------------------
#BIS
BIS <- SDMXServiceProvider(
agencyId = "BIS", name = "Bank for International Settlements",
builder = SDMXREST21RequestBuilder(
regUrl = "https://stats.bis.org/api/v1",
repoUrl = "https://stats.bis.org/api/v1",
compliant = TRUE
)
)
#ECB
ECB <- SDMXServiceProvider(
agencyId = "ECB", name = "European Central Bank",
builder = SDMXREST21RequestBuilder(
regUrl = "https://data-api.ecb.europa.eu/service",
repoUrl = "https://data-api.ecb.europa.eu/service",
skipTrailingSlash = TRUE,
compliant = TRUE
)
)
#EUROSTAT
ESTAT <- SDMXServiceProvider(
agencyId = "ESTAT", name = "Eurostat (Statistical office of the European Union)",
builder = SDMXREST21RequestBuilder(
regUrl = "https://ec.europa.eu/eurostat/api/dissemination/sdmx/2.1",
repoUrl = "https://ec.europa.eu/eurostat/api/dissemination/sdmx/2.1",
compliant = TRUE
)
)
ESTAT@builder@handler$dataflow = function(obj){
if(is.null(obj@resourceId)) obj@resourceId = "all"
if(is.null(obj@version)) obj@version = "latest"
req <- sprintf("%s/dataflow/ESTAT/%s/%s/",obj@regUrl, obj@resourceId, obj@version)
return(req)
}
ESTAT@builder@handler$datastructure = function(obj){
if(is.null(obj@resourceId)) obj@resourceId = "all"
if(is.null(obj@version)) obj@version = "latest"
req <- sprintf("%s/datastructure/ESTAT/%s/%s/",obj@regUrl, obj@resourceId, obj@version)
req <- paste0(req, "?references=children") #TODO to see later to have arg for this
return(req)
}
#ESTAT_COMEXT
ESTAT_COMEXT <- SDMXServiceProvider(
agencyId = "ESTAT", name = "Eurostat (Statistical office of the European Union) - COMEXT",
builder = SDMXREST21RequestBuilder(
regUrl = "https://ec.europa.eu/eurostat/api/comext/dissemination/sdmx/2.1",
repoUrl = "https://ec.europa.eu/eurostat/api/comext/dissemination/sdmx/2.1",
compliant = TRUE
)
)
ESTAT_COMEXT@builder@handler$dataflow = ESTAT@builder@handler$dataflow
ESTAT_COMEXT@builder@handler$datastructure = ESTAT@builder@handler$datastructure
#ESTAT_GROW
ESTAT_GROW <- SDMXServiceProvider(
agencyId = "ESTAT", name = "Eurostat (Statistical office of the European Union) - DG GROW",
builder = SDMXREST21RequestBuilder(
regUrl = "https://webgate.ec.europa.eu/grow/redisstat/api/dissemination/sdmx/2.1",
repoUrl = "https://webgate.ec.europa.eu/grow/redisstat/api/dissemination/sdmx/2.1",
compliant = TRUE
)
)
ESTAT_GROW@builder@handler$dataflow = ESTAT@builder@handler$dataflow
ESTAT_GROW@builder@handler$datastructure = ESTAT@builder@handler$datastructure
#ESTAT_COMP
ESTAT_COMP <- SDMXServiceProvider(
agencyId = "ESTAT", name = "Eurostat (Statistical office of the European Union) - DG COMP",
builder = SDMXREST21RequestBuilder(
regUrl = "https://webgate.ec.europa.eu/comp/redisstat/api/dissemination/sdmx/2.1",
repoUrl = "https://webgate.ec.europa.eu/comp/redisstat/api/dissemination/sdmx/2.1",
compliant = TRUE
)
)
ESTAT_COMP@builder@handler$dataflow = ESTAT@builder@handler$dataflow
ESTAT_COMP@builder@handler$datastructure = ESTAT@builder@handler$datastructure
#ESTAT_EMPL
ESTAT_EMPL <- SDMXServiceProvider(
agencyId = "ESTAT", name = "Eurostat (Statistical office of the European Union) - DG EMPL",
builder = SDMXREST21RequestBuilder(
regUrl = "https://webgate.ec.europa.eu/empl/redisstat/api/dissemination/sdmx/2.1",
repoUrl = "https://webgate.ec.europa.eu/empl/redisstat/api/dissemination/sdmx/2.1",
compliant = TRUE
)
)
ESTAT_EMPL@builder@handler$dataflow = ESTAT@builder@handler$dataflow
ESTAT_EMPL@builder@handler$datastructure = ESTAT@builder@handler$datastructure
#IMF
IMF <- SDMXServiceProvider(
agencyId = "IMF", name = "International Monetary Fund",
builder = SDMXREST21RequestBuilder(
regUrl = "https://sdmxcentral.imf.org/ws/public/sdmxapi/rest",
repoUrl = "https://sdmxcentral.imf.org/ws/public/sdmxapi/rest",
compliant = TRUE,
unsupportedResources = list("data")
)
)
#IMF_DATA
IMF_DATA <- SDMXServiceProvider(
agencyId = "IMF_DATA", name = "International Monetary Fund - Data Portal",
builder = SDMXREST21RequestBuilder(
regUrl = "https://api.imf.org/external/sdmx/2.1",
repoUrl = "https://api.imf.org/external/sdmx/2.1",
compliant = TRUE,
formatter = list(
datastructure = function(obj){
if(is.null(obj@references)) obj@references = "descendants"
return(obj)
}
)
)
)
#OECD
OECD <- SDMXServiceProvider(
agencyId = "OECD", name = "Organisation for Economic Cooperation and Development ",
builder = SDMXREST21RequestBuilder(
regUrl = "https://sdmx.oecd.org/public/rest",
repoUrl = "https://sdmx.oecd.org/public/rest",
compliant = TRUE
)
)
#UNICEF
UNICEF <- SDMXServiceProvider(
agencyId = "UNICEF", "United Nations International Children's Emergency Fund",
builder = SDMXREST21RequestBuilder(
regUrl = "https://sdmx.data.unicef.org/ws/public/sdmxapi/rest",
repoUrl = "https://sdmx.data.unicef.org/ws/public/sdmxapi/rest",
compliant = TRUE
)
)
#COUNTDOWN 2030
CD2030 <- SDMXServiceProvider(
agencyId = "CD2030", "United Nations International Children's Emergency Fund",
builder = SDMXREST21RequestBuilder(
regUrl = "https://sdmx.data.unicef.org/ws/public/sdmxapi/rest",
repoUrl = "https://sdmx.data.unicef.org/ws/public/sdmxapi/rest",
compliant = TRUE
)
)
#UNSD
UNSD <- SDMXServiceProvider(
agencyId = "UNSD", "United Nations Statistics Division",
builder = SDMXREST21RequestBuilder(
regUrl = "http://data.un.org/WS/rest",
repoUrl = "http://data.un.org/WS/rest",
compliant = TRUE
)
)
#UN-ILO (Legacy)
ILO_Legacy <- SDMXServiceProvider(
agencyId = "ILO_Legacy", name = "International Labour Organization of the United Nations",
builder = SDMXREST21RequestBuilder(
regUrl = "http://www.ilo.org/ilostat/sdmx/ws/rest",
repoUrl = "http://www.ilo.org/ilostat/sdmx/ws/rest",
compliant = FALSE,
skipProviderId = TRUE,
unsupportedResources = list("dataflow")
)
)
#UN-ILO
ILO <- SDMXServiceProvider(
agencyId = "ILO", name = "International Labour Organization of the United Nations",
builder = SDMXREST21RequestBuilder(
regUrl = "https://sdmx.ilo.org/rest",
repoUrl = "https://sdmx.ilo.org/rest",
compliant = TRUE,
skipProviderId = TRUE
)
)
#WBG_WITS (World Integrated Trade Solution)
WBG_WITS <- SDMXServiceProvider(
agencyId = "WBG_WITS", name = "World Integrated Trade Solution",
builder = SDMXREST21RequestBuilder(
regUrl = "https://wits.worldbank.org/API/V1/SDMX/V21/rest",
repoUrl = "https://wits.worldbank.org/API/V1/SDMX/V21/rest",
compliant = TRUE,
skipProviderId = TRUE
)
)
#WB (World Bank)
WB <- SDMXServiceProvider(
agencyId = "WB", name = "World Bank",
builder = SDMXREST21RequestBuilder(
regUrl = "http://api.worldbank.org/v2/sdmx/rest",
repoUrl = "http://api.worldbank.org/v2/sdmx/rest",
compliant = TRUE,
skipProviderId = TRUE
)
)
#PDH.STAT (Pacific Data Hub by The Pacific Community)
PDH <- SDMXServiceProvider(
agencyId = "PDH", name = "Pacific Data Hub DotStat",
builder = SDMXREST21RequestBuilder(
regUrl = "https://stats-nsi-stable.pacificdata.org/rest",
repoUrl = "https://stats-nsi-stable.pacificdata.org/rest",
compliant = FALSE
)
)
#national data providers
#-----------------------
#ABS {Australia}
ABS <- SDMXServiceProvider(
agencyId = "ABS", name = "Australian Bureau of Statistics",
scale = "national", country = "AUS",
builder = SDMXREST21RequestBuilder(
regUrl = "https://api.data.abs.gov.au",
repoUrl = "https://api.data.abs.gov.au",
compliant = TRUE
)
)
#NBB {Belgium}
NBB <- SDMXServiceProvider(
agencyId = "NBB", name = "National Bank of Belgium",
scale = "national", country = "BEL",
builder = SDMXDotStatRequestBuilder(
regUrl = "https://stat.nbb.be/RestSDMX/sdmx.ashx",
repoUrl = "https://stat.nbb.be/RestSDMX/sdmx.ashx",
unsupportedResources = list("dataflow")
)
)
#INSEE {France}
INSEE <- SDMXServiceProvider(
agencyId = "INSEE", name = "Institut national de la statistique et des \u00e9tudes \u00e9conomiques",
scale = "national", country = "FRA",
builder = SDMXREST21RequestBuilder(
regUrl = "https://bdm.insee.fr/series/sdmx",
repoUrl = "https://bdm.insee.fr/series/sdmx",
compliant = TRUE
)
)
#INEGI (Mexico)
INEGI <- SDMXServiceProvider(
agencyId = "INEGI", name = "Instituto Nacional de Estad\u00edstica y Geograf\u00eda (M\u00e9jico)",
scale = "national", country = "MEX",
builder = SDMXREST21RequestBuilder(
regUrl = "https://sdmx.snieg.mx/ServiceV6/rest",
repoUrl = "https://sdmx.snieg.mx/ServiceV6/rest",
compliant = FALSE
)
)
#ISTAT - LEGACY (Italy)
ISTAT_LEGACY <- SDMXServiceProvider(
agencyId = "ISTAT_LEGACY", name = "Istituto nazionale di statistica (Italia)",
scale = "national", country = "ITA",
builder = SDMXREST21RequestBuilder(
regUrl = "http://sdmx.istat.it/SDMXWS/rest",
repoUrl = "http://sdmx.istat.it/SDMXWS/rest",
compliant = TRUE
)
)
#ISTAT (Italy)
ISTAT <- SDMXServiceProvider(
agencyId = "ISTAT", name = "Istituto nazionale di statistica (Italia)",
scale = "national", country = "ITA",
builder = SDMXREST21RequestBuilder(
regUrl = "https://esploradati.istat.it/SDMXWS/rest",
repoUrl = "https://esploradati.istat.it/SDMXWS/rest",
compliant = TRUE
)
)
#NOMIS (UK Official Labour Market statistics)
NOMIS <- SDMXServiceProvider(
agencyId = "NOMIS", name = "NOMIS - UK Official Labour Market Statistics",
scale = "national", country = "UK",
builder = SDMXRequestBuilder(
regUrl = "https://www.nomisweb.co.uk/api/v01",
repoUrl = "https://www.nomisweb.co.uk/api/v01",
compliant = FALSE,
formatter = list(
dataflow = function(obj){return(obj)},
datastructure = function(obj){return(obj)},
data = function(obj){return(obj)}
),
handler = list(
#dataflow resource (path="dataset/resourceId/def.sdmx.xml")
#-----------------------------------------------------------------------
dataflow = function(obj){
req <- sprintf("%s/dataset", obj@regUrl)
if(!is.null(obj@resourceId)) req <- paste(req, obj@resourceId, sep="/")
req <- paste(req, "def.sdmx.xml", sep="/")
return(req)
},
#datastructure resource (path="dataset/resourceID.structure.sdmx.xml")
#-----------------------------------------------------------------------
datastructure = function(obj){
req <- sprintf("%s/dataset", obj@regUrl)
if(is.null(obj@resourceId)) stop("Missing 'resourceId' value")
req <- paste(req, obj@resourceId, sep="/")
req <- paste0(req, ".structure.sdmx.xml")
return(req)
},
#data resource (path="dataset/resourceID.generic.sdmx.xml")
#----------------------------------------------------------
data = function(obj){
req <- sprintf("%s/dataset", obj@repoUrl)
if(is.null(obj@flowRef)) stop("Missing 'flowRef' value")
req <- paste(req, obj@flowRef, sep="/")
req <- paste0(req, ".compact.sdmx.xml")
return(req)
}
)
)
)
#LSD - Lithuanian Department of Statistics (Statistics Lithuania)
LSD <- SDMXServiceProvider(
agencyId = "LSD", "Statistics Lithuania",
scale = "national", country = "LTU",
builder = SDMXREST21RequestBuilder(
regUrl = "https://osp-rs.stat.gov.lt/rest_xml",
repoUrl = "https://osp-rs.stat.gov.lt/rest_xml",
compliant = TRUE, skipProviderId = TRUE
)
)
#NCSI - Sultanate of Oman - National Center for Statistics & Information
#Based on KNOEMA SDMX server implementation
NCSI <- SDMXServiceProvider(
agencyId = "NCSI", "Sultanate of Oman - National Center for Statistics & Information",
scale = "national", country = "OMN",
builder = SDMXRequestBuilder(
regUrl = "https://data.gov.om/api/1.0/sdmx",
repoUrl = "https://data.gov.om/api/1.0/sdmx",
formatter = list(
dataflow = function(obj){return(obj)},
datastructure = function(obj){return(obj)},
data = function(obj){return(obj)}
),
handler = list(
#dataflow resource (path="/")
#-----------------------------------------------------------------------
dataflow = function(obj){
return(obj@regUrl)
},
#datastructure resource (path="/resourceID)
#-----------------------------------------------------------------------
datastructure = function(obj){
req <- paste(obj@regUrl, obj@resourceId, sep = "/")
return(req)
},
#data resource (path="getdata?dataflow=flowRef&key=key)
#----------------------------------------------------------
data = function(obj){
if(is.null(obj@flowRef)) stop("Missing flowRef value")
if(is.null(obj@key)) obj@key = "."
#base data request
req <- sprintf("%s/data/%s/%s?", obj@repoUrl, obj@flowRef, obj@key)
#DataQuery
#-> temporal extent (if any)
if(!is.null(obj@start)) {
req <- paste0(req, "startPeriod=",obj@start)
}
if(!is.null(obj@end)) {
if(!grepl("\\?$", req)) req <- paste0(req,"&")
req <- paste0(req, "endPeriod=",obj@end)
}
return(req)
}
),
compliant = FALSE
)
)
#UKDS removed - no support for SDMX-JSON in rsdmx at now
#UKDS <- SDMXServiceProvider(
# agencyId = "UKDS", name = "United Kingdom Data Service",
# scale = "national", country = "UK",
# builder = SDMXDotStatRequestBuilder(
# regUrl = "http://stats.ukdataservice.ac.uk/restsdmx/sdmx.ashx",
# repoUrl = "http://stats.ukdataservice.ac.uk/restsdmx/sdmx.ashx",
# unsupportedResources = list("dataflow")
# )
#)
#Bundesbank
BBK <- SDMXServiceProvider(
agencyId = "BBK", name = "Bundesbank",
scale = "national", country = "DEU",
builder = SDMXRequestBuilder(
regUrl = "https://api.statistiken.bundesbank.de/rest/metadata",
repoUrl = "https://api.statistiken.bundesbank.de/rest",
formatter = list(
dataflow = function(obj){return(obj)},
datastructure = function(obj){return(obj)},
data = function(obj){return(obj)}
),
#resource handler
handler = list(
#dataflow resource (dataflow/agencyID/resourceID/version)
#-----------------------------------------------------------------------
dataflow = function(obj){
req <- sprintf("%s/dataflow/%s",obj@regUrl, obj@providerId)
if(!is.null(obj@resourceId)) req <- paste(req, obj@resourceId, sep = "/")
return(req)
},
#datastructure resource (datastructure/agencyID/resourceID/version)
#--------------------------------------------------------------------------------
datastructure = function(obj){
req <- sprintf("%s/datastructure/%s",obj@regUrl, obj@providerId)
if(!is.null(obj@resourceId)) req <- paste(req, obj@resourceId, sep = "/")
req <- paste0(req, "?references=children") #TODO to see later to have arg for this
return(req)
},
#data resource (data/flowRef/key/providerRef)
#----------------------------------------------------------
data = function(obj){
if(is.null(obj@flowRef)) stop("Missing flowRef value")
req <- sprintf("%s/data/%s/%s",obj@repoUrl, obj@flowRef, obj@key)
#DataQuery
#-> temporal extent (if any)
addParams = FALSE
if(!is.null(obj@start)){
req <- paste0(req, "?")
addParams = TRUE
req <- paste0(req, "startPeriod=", obj@start)
}
if(!is.null(obj@end)){
if(!addParams){
req <- paste0(req, "?")
}else{
req <- paste0(req, "&")
}
req <- paste0(req, "endPeriod=", obj@end)
}
return(req)
}
),
compliant = FALSE
)
)
#other data providers
#--------------------
#KNOEMA (Open data plateform)
KNOEMA <- SDMXServiceProvider(
agencyId = "KNOEMA", name = "KNOEMA knowledge plateform",
builder = SDMXRequestBuilder(
regUrl = "http://knoema.fr/api/1.0/sdmx",
repoUrl = "http://knoema.fr/api/1.0/sdmx",
formatter = list(
dataflow = function(obj){return(obj)},
datastructure = function(obj){return(obj)},
data = function(obj){return(obj)}
),
handler = list(
#dataflow resource (path="/")
#-----------------------------------------------------------------------
dataflow = function(obj){
return(obj@regUrl)
},
#datastructure resource (path="/resourceID)
#-----------------------------------------------------------------------
datastructure = function(obj){
req <- paste(obj@regUrl, obj@resourceId, sep = "/")
return(req)
},
#data resource (path="getdata?dataflow=flowRef&key=key)
#----------------------------------------------------------
data = function(obj){
if(is.null(obj@flowRef)) stop("Missing flowRef value")
if(is.null(obj@key)) obj@key = "."
#base data request
req <- sprintf("%s/getdata?dataflow=%s&key=%s", obj@repoUrl, obj@flowRef, obj@key)
#DataQuery
#-> temporal extent (if any)
if(!is.null(obj@start) | !is.null(obj@end)) {
warning("start/end parameters ignored for this SDMX API")
}
return(req)
}
),
compliant = FALSE
)
)
listOfProviders <- list(
#international
BIS, ECB, ESTAT, ESTAT_COMEXT, ESTAT_COMP, ESTAT_GROW, ESTAT_EMPL, IMF, IMF_DATA, OECD, UNICEF, CD2030, UNSD, ILO_Legacy, ILO, WBG_WITS, WB, PDH,
#national
ABS, NBB, INSEE, INEGI, ISTAT_LEGACY, ISTAT, NOMIS, LSD, NCSI, BBK,
#others
KNOEMA
)
.rsdmx.options$providers <- new("SDMXServiceProviders", providers = listOfProviders)
} # nocov end
#' @name addSDMXServiceProvider
#' @aliases addSDMXServiceProvider
#' @title addSDMXServiceProvider
#' @description function that allows configuring a new \link{SDMXServiceProvider}
#' as part of the list of providers known by \pkg{rsdmx}, hence by
#' \link{readSDMX}
#'
#' @usage
#' addSDMXServiceProvider(provider)
#'
#' @param provider an object of class "SDMXServiceProvider"
#'
#' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
#'
#' @examples
#' #create a provider
#' myBuilder <- SDMXREST20RequestBuilder(regUrl = "http://www.myorg.org/registry",
#' repoUrl = "http://www.myorg.org/repository",
#' compliant = TRUE)
#' myProvider <- SDMXServiceProvider(
#' agencyId = "MYORG", name = "My Organization",
#' builder = myBuilder
#' )
#'
#' #add it
#' addSDMXServiceProvider(myProvider)
#'
#' #check out the list of existing provider (only list the agency Ids)
#' sapply(slot(getSDMXServiceProviders(), "providers"), function(x){slot(x, "agencyId")})
#'
#' @seealso \link{getSDMXServiceProviders} \link{findSDMXServiceProvider}
#' \link{readSDMX}
#' @export
#'
addSDMXServiceProvider <- function(provider){
.rsdmx.options$providers <- new("SDMXServiceProviders",
providers = c(slot(.rsdmx.options$providers, "providers"), provider)
)
}
#' @name getSDMXServiceProviders
#' @aliases getSDMXServiceProviders
#' @title getSDMXServiceProviders
#' @description function used to get the list of \link{SDMXServiceProvider} known
#' by \pkg{rsdmx} (hence known by \link{readSDMX} to query data or
#' metadata in an easier way). This function can be easily used to
#' interrogate the list of known providers, and eventually consider
#' adding one at runtime with \link{addSDMXServiceProvider}
#' @usage
#' getSDMXServiceProviders()
#'
#' @return an object of class "list" (of \link{SDMXServiceProvider})
#'
#' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
#'
#' @seealso \link{addSDMXServiceProvider} \link{findSDMXServiceProvider}
#' \link{readSDMX}
#' @export
#'
getSDMXServiceProviders <- function(){
out <- .rsdmx.options$providers
return(out)
}
#' @name findSDMXServiceProvider
#' @aliases findSDMXServiceProvider
#' @title findSDMXServiceProvider
#'
#' @description function that allows searching by provider id in the list of
#' known \link{SDMXServiceProvider}. This function can be used for
#' interrogating the list of default providers known by \pkg{rsdmx},
#' and is used internally by \link{readSDMX}
#' @usage
#' findSDMXServiceProvider(agencyId)
#'
#' @param agencyId an object of class "character" representing a provider
#' identifier
#' @return an object of class "SDMXServiceProvider" (or NULL if no matching)
#'
#' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
#'
#' @examples
#' #find OECD provider
#' oecd.provider <- findSDMXServiceProvider("OECD")
#'
#' @seealso \link{getSDMXServiceProviders} \link{addSDMXServiceProvider}
#' \link{readSDMX}
#' @export
findSDMXServiceProvider <- function(agencyId){
if(is.null(agencyId)) return(NULL)
res <- unlist(lapply(slot(getSDMXServiceProviders(),"providers"),
function(x) {if(x@agencyId == agencyId){return(x)}}))
if(!is.null(res) && length(res) > 0) res <- res[[1]]
return(res)
}
|
