File: SDMXFooter.Rd

package info (click to toggle)
r-cran-rsdmx 1%3A0.6%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,000 kB
  • sloc: makefile: 2
file content (50 lines) | stat: -rw-r--r-- 1,500 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Class-SDMXFooter.R, R/SDMXFooter-methods.R
\docType{class}
\name{SDMXFooter}
\alias{SDMXFooter}
\alias{SDMXFooter-class}
\alias{SDMXFooter,SDMXFooter-method}
\title{Class "SDMXFooter"}
\usage{
SDMXFooter(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 "SDMXFooter"
}
\description{
A basic class to handle the footer of a SDMX-ML document
}
\section{Slots}{

\describe{
\item{\code{messages}}{Object of class "SDMXFooterMessage" giving the list of messages}
}}

\note{
This class is especially useful for SDMX 2.1 compliant documents. Footer 
messages are not supported in SDMX 2.0standard format. In this case, the footer 
will return an empty message list().

According to the SDMX 2.1 standard, the message severity takes one of the 
following values: "Error", "Warning","Information". Given the possible typos 
handled by data providers, rsdmx adopts a permissive strategy and does not 
validate the object according to such controlled terms.
}
\section{Warning}{

This class is not useful in itself, but all SDMX non-abstract classes will 
encapsulate it as slot, when parsing an SDMX-ML document.
}

\seealso{
\link{readSDMX}
}
\author{
Emmanuel Blondel, \email{emmanuel.blondel1@gmail.com}
}