SDMXCodelist

SDMXCodelist-class

SDMXCodelist,SDMXCodelist-method

A basic class to handle a SDMX Codelist

Set of classes and methods to read data and metadata documents
exchanged through the Statistical Data and Metadata Exchange (SDMX) framework,
currently focusing on the SDMX XML standard format (SDMX-ML).

Emmanuel Blondel

rsdmx

Tools for Reading SDMX Data and Metadata

Matthieu Stigler

Eric Persson

SDMXCodelist function

<dl><dt>xmlObj</dt>
<dd>object of class "XMLInternalDocument derived from XML package</dd>
<dt>namespaces</dt>
<dd>object of class "data.frame" given the list of namespace URIs</dd></dl>

Arguments

<dl>
<dt><code>id</code></dt>
<dd>Object of class "character" giving the ID of the codelist (required)</dd></dl>
<dt><code>agencyID</code></dt>
<dd>Object of class "character" giving the AgencyID</dd>
<dt><code>version</code></dt>
<dd>Object of class "character" giving the version</dd>
<dt><code>uri</code></dt>
<dd>Object of class "character" giving the codelist uri</dd>
<dt><code>urn</code></dt>
<dd>Object of class "character" giving the codelist urn</dd>
<dt><code>isExternalReference</code></dt>
<dd>Object of class "logical" indicating if the codelist is an external reference</dd>
<dt><code>isFinal</code></dt>
<dd>Object of class "logical" indicating if the codelist is final</dd>
<dt><code>validFrom</code></dt>
<dd>Object of class "character" indicating the start validity period</dd>
<dt><code>validTo</code></dt>
<dd>Object of class "character" indicating the end validity period</dd>
<dt><code>Name</code></dt>
<dd>Object of class "list" giving the codelist (by language) - required</dd>
<dt><code>Description</code></dt>
<dd>Object of class "list" giving the codelist description (by language)</dd>
<dt><code>Code</code></dt>
<dd>Object of class "list" giving the list of "SDMXCode" objects included in the codelist (see SDMXCode)</dd>

Slots

This class is not useful in itself, but all SDMX non-abstract classes will 
encapsulate it as slot, when parsing an SDMX-ML document (Codelists, or DataStructureDefinition)

Warning

Emmanuel Blondel, <a href="/link/emmanuel.blondel1%40gmail.com?package=rsdmx&version=0.6-4" data-mini-rdoc="rsdmx::emmanuel.blondel1@gmail.com">emmanuel.blondel1@gmail.com</a>

Author

Class "SDMXCodelist" — SDMXCodelist

<dl>

<dt>xmlObj</dt>
<dd>object of class "XMLInternalDocument derived from XML package</dd>


<dt>namespaces</dt>
<dd>object of class "data.frame" given the list of namespace URIs</dd>

</dl>

<dl>
<dt><code>id</code></dt>
<dd>Object of class "character" giving the ID of the codelist (required)</dd>


<dt><code>agencyID</code></dt>
<dd>Object of class "character" giving the AgencyID</dd>


<dt><code>version</code></dt>
<dd>Object of class "character" giving the version</dd>


<dt><code>uri</code></dt>
<dd>Object of class "character" giving the codelist uri</dd>


<dt><code>urn</code></dt>
<dd>Object of class "character" giving the codelist urn</dd>


<dt><code>isExternalReference</code></dt>
<dd>Object of class "logical" indicating if the codelist is an external reference</dd>


<dt><code>isFinal</code></dt>
<dd>Object of class "logical" indicating if the codelist is final</dd>


<dt><code>validFrom</code></dt>
<dd>Object of class "character" indicating the start validity period</dd>


<dt><code>validTo</code></dt>
<dd>Object of class "character" indicating the end validity period</dd>


<dt><code>Name</code></dt>
<dd>Object of class "list" giving the codelist (by language) - required</dd>


<dt><code>Description</code></dt>
<dd>Object of class "list" giving the codelist description (by language)</dd>


<dt><code>Code</code></dt>
<dd>Object of class "list" giving the list of "SDMXCode" objects included in the codelist (see SDMXCode)</dd>


</dl>

This class is not useful in itself, but all SDMX non-abstract classes will 
encapsulate it as slot, when parsing an SDMX-ML document (Codelists, or DataStructureDefinition)

Emmanuel Blondel, <a href='mailto:emmanuel.blondel1@gmail.com'>emmanuel.blondel1@gmail.com</a>

SDMXCodelist: Class "SDMXCodelist"

Description

Usage

Value

Arguments

Slots

Warning

Author

See Also