File: SDMX.Rd

package info (click to toggle)
r-cran-rsdmx 1%3A0.6-2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,016 kB
  • sloc: sh: 13; makefile: 2
file content (53 lines) | stat: -rw-r--r-- 1,623 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Class-SDMX.R, R/SDMX-methods.R
\docType{class}
\name{SDMX}
\alias{SDMX}
\alias{SDMX-class}
\alias{SDMX,SDMX-method}
\title{Class "SDMX"}
\usage{
SDMX(xmlObj, namespaces)
}
\arguments{
\item{xmlObj}{object of class "XMLInternalDocument derived from XML package}

\item{namespaces}{object of class "data.frame" given the list of namespace URIs}
}
\value{
an object of class "SDMX"
}
\description{
An abstract class from which SDMX classes are derived
}
\section{Slots}{

\describe{
\item{\code{xmlObj}}{Object of class "XMLInternalDocument" derived from XML package}

\item{\code{schema}}{Object of class "SDMXSchema", handles the version of SDMX-ML format}

\item{\code{header}}{Object of class "SDMXHeader", handles the SDMX-ML document header}

\item{\code{footer}}{Object of class "SDMXFooter", handles the SDMX-ML document footer}
}}

\note{
Currently, the approach drafted in \link{rsdmx} package was to rely on XML
 package, read the xml object and store it as part of the SDMX R object. Another
 approach being investigated is to use XML handlers throughthe Simple API for XML
 (SAX) that could avoid to load the full XML tree in the SDMX R object (xmlObj). 
 Indeed, SDMX data could be huge and causes issues of memory if the complete XML
 tree is loaded in the R user session.
 
 @author Emmanuel Blondel, \email{emmanuel.blondel1@gmail.com}
}
\section{Warning}{

This class is not useful in itself, but all SDMX classes in this package derive
from it.
}

\seealso{
\link{readSDMX}
}