SDMXHeader: Class "SDMXHeader"

In opensdmx/rsdmx: Tools for Reading SDMX Data and Metadata

Class "SDMXHeader"

Description

A basic class to handle the header of a SDMX-ML document

Usage

SDMXHeader(xmlObj, namespaces)

Arguments

xmlObj	object of class "XMLInternalDocument derived from XML package
namespaces	object of class "data.frame" given the list of namespace URIs

Value

an object of class "SDMXHeader"

Slots

ID

Object of class "character" giving the ID of the SDMX-ML document

Test

Object of class "logical" indicating if the SDMX-ML document is disseminated for test purpose

Truncated

Object of class "logical" indicating if the SDMX-ML document is truncated

Name

Object of class "character" giving the name of SDMX-ML document

Sender

Object of class "list" giving the id of the sender and eventually its in name, possibly in multi-languages

Receiver

Object of class "list" giving the id of the receiver and eventually its in name, possibly in multi-languages

Prepared

Object of class "POSIXlt" giving the preparation date of the SDMX-ML document

Extracted

Object of class "POSIXlt" giving the extraction date of the SDMX-ML document

ReportingBegin

Object of class "POSIXlt" giving the reporting begin date for the data retrieved in the SDMX-ML document

ReportingEnd

Object of class "POSIXlt" giving the reporting end date for the data retrieved in the SDMX-ML document

Source

Object of class "character" giving the source of the SDMX-ML document

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

Note

Some SDMXHeader properties are not yet supported and thus not available as "slots". These are "KeyFamilyRef", "KeyFamilyAgency", "DataSetAgency", "DataSetID", "DataSetAction".

Author(s)

Emmanuel Blondel, [e-mail]

See Also

readSDMX

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