File: SDMXServiceProvider.Rd

package info (click to toggle)
r-cran-rsdmx 1%3A0.5-13%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 984 kB
  • sloc: makefile: 2
file content (64 lines) | stat: -rw-r--r-- 2,391 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/Class-SDMXServiceProvider.R, R/SDMXServiceProvider-methods.R
\docType{class}
\name{SDMXServiceProvider}
\alias{SDMXServiceProvider}
\alias{SDMXServiceProvider,SDMXServiceProvider-method}
\alias{SDMXServiceProvider-class}
\title{Class "SDMXServiceProvider"}
\usage{
SDMXServiceProvider(agencyId, name, scale, country, builder)
}
\arguments{
\item{agencyId}{an object of class "character" giving the a provider identifier}

\item{name}{an object of class "character" giving the name of the provider}

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

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

\item{builder}{an object of class "SDMXRequestBuilder" that will performs the
web request building for this specific provider}
}
\value{
an object of class "SDMXServiceProvider"
}
\description{
A basic class to handle a SDMX service provider
}
\section{Slots}{

\describe{
\item{\code{agencyId}}{an object of class "character" giving the a provider identifier}

\item{\code{name}}{an object of class "character" giving the name of the provider}

\item{\code{scale}}{an object of class "character" giving the scale of the datasource,
either "international" or "national"}

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

\item{\code{builder}}{an object of class "SDMXRequestBuilder" that will performs the
      web request building}
}}
\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)
}
\author{
Emmanuel Blondel, \email{emmanuel.blondel1@gmail.com}

Emmanuel Blondel, \email{emmanuel.blondel1@gmail.com}
}