SDMXServiceProvider: Class "SDMXServiceProvider"

View source: R/SDMXServiceProvider-methods.R

SDMXServiceProviderR Documentation

Class "SDMXServiceProvider"

Description

A basic class to handle a SDMX service provider

Usage

SDMXServiceProvider(agencyId, name, scale, country, builder)

Arguments

agencyId

an object of class "character" giving the a provider identifier

name

an object of class "character" giving the name of the provider

scale

an object of class "character" giving the scale of the datasource, either "international" or "national". Default value is "international".

country

an object of class "character" giving the ISO 3-alpha code of the country (if scale is "national"). Default value is NA

builder

an object of class "SDMXRequestBuilder" that will performs the web request building for this specific provider

Value

an object of class "SDMXServiceProvider"

Slots

agencyId

an object of class "character" giving the a provider identifier

name

an object of class "character" giving the name of the provider

scale

an object of class "character" giving the scale of the datasource, either "international" or "national"

country

an object of class "character" giving the ISO 3-alpha code of the country (if scale is "national")

builder

an object of class "SDMXRequestBuilder" that will performs the web request building

Author(s)

Emmanuel Blondel, 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)
                                  

opensdmx/rsdmx documentation built on Feb. 12, 2024, 12:13 a.m.