DatasetInSystem

datasets available in a EUROMOD system

collapse all in page

Syntax

D = DatasetInSystem(System)

Description

example

D = DatasetInSystem(System) create a class array with the System default datasets.

This class contains the datasets modelled in a EUROMOD system. The class elements can be accessed by indexing the class array with an integer, or a string value of any class property (e.g. name, ID, bestMatch, etc.).

This class is stored in the property datasets of the System class.

This class inherits methods and properties from the superclass Dataset.

Examples

collapse all

Open Live Script

DatasetInSystem loads all the datasets configured in a System by default.

mod = euromod("C:\EUROMOD_RELEASES_I6.0+");
D=DatasetInSystem(mod.countries("AT").systems(end));
D  
4×1 DatasetInSystem array:

        1: training_data | 
        2: AT_2020_b2    | 
        3: AT_2021_b1    | best match
        4: AT_2023_hhot  |

Display a specific dataset in the System.

D("AT_2021_b1")  
1×1 DatasetInSystem with properties:

       bestMatch: "yes"
          dataID: "b781f486-9a8a-4704-a9bd-51e5cccec985"
           sysID: "064cf5eb-73bd-4fae-a421-ed9781e418c9"
   coicopVersion: ""
         comment: ""
        currency: "euro"
     decimalSign: "."
              ID: "064cf5eb-73bd-4fae-a421-ed9781e418c9b781f486-9a8a-4704-a9bd-51e5cccec985"
listStringOutVar: ""
            name: "AT_2021_b1"
          parent: [1×1 System]
         private: "no"
  readXVariables: "no"
useCommonDefault: "no"
  yearCollection: "2021"
         yearInc: "2020"

Input Arguments

collapse all

A specific system from the System class array.

Data Types: class

Properties

collapse all

If yes, the current dataset is a best match for the specific system.

Example: D(end).bestMatch

Returns the COICOP version.

Example: D(end).coicopVersion

Returns the comment about the dataset.

Example: D(end).comment

Returns the currency of the monetary values in the dataset.

Example: D(end).currency

Returns the identifier number of the dataset at the system level.

Example: D(end).dataID

Returns the decimal delimiter of float values.

Example: D(end).decimalSign

Returns the dataset identifier number.

Example: D(end).ID

Returns the names of variables.

Example: D(end).listStringOutVar

Returns the name of the dataset.

Example: D(end).name

Returns the specific System class.

Example: D(end).parent

Returns the access type of the dataset.

Example: D(end).private

Returns the loaded variables.

Example: D(end).readXVariables

Returns the identifier number of the reference system.

Example: D(end).sysID

Returns the use default.

Example: D(end).useCommonDefault

Returns the year of the dataset collection.

Example: D(end).yearCollection

Returns the reference year for the income variables.

Example: D(end).yearInc

Output Arguments

collapse all

A class array with the System default datasets.

References

[1] Documentation EUROMOD - Tax-benefit microsimulation model for the European Union.

Extended Capabilities

See Also

Introduced in R2023a