System

The EUROMOD tax-benefit systems implemented in a country.

collapse all in page

Syntax

S = System(Country)

Description

example

S = System(Country) create a class array with the tax-benefit systems of a Country.

This class contains the EUROMOD tax-benefit systems of a specific country. 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, year, etc.).

This class is stored in the property systems of the Country class.

This class stores classes of type DatasetInSystem and PolicyInSystem.

Examples

collapse all

Open Live Script

System loads all the systems configured in a Country by default.

mod = euromod("C:\EUROMOD_RELEASES_I6.0+");
S=System(mod.countries("AT"));
S  
17×1 System array:
     1: AT_2007
     2: AT_2008
     3: AT_2009
     4: AT_2010
     5: AT_2011
     6: AT_2012
     7: AT_2013
     8: AT_2014
     9: AT_2015
    10: AT_2016
    11: AT_2017
    12: AT_2018
    13: AT_2019
    14: AT_2020
    15: AT_2021
    16: AT_2022
    17: AT_2023

Display a specific system in the Country.

S("AT_2021")  
1×1 System with properties:

bestmatchDatasets: "AT_2021_b1"
          comment: ""
   currencyOutput: "euro"
    currencyParam: "euro"
         datasets: "training_data, AT_2019_b2, AT_2021_hhot, AT_2020_b2, AT_2021_b1"
               ID: "ca63e8ca-db68-4f4c-9b90-b5717e7a3776"
       headDefInc: "ils_origy"
             name: "AT_2021"
           parent: [1×1 Country]
         policies: [54×1 PolicyInSystem]
          private: "no"
            order: "16"
             year: "2021"

Input Arguments

collapse all

A specific country from the Country class array.

Data Types: class

Properties

collapse all

Returns a DatasetInSystem class with best-match datasets for the system.

Example: S(end).bestmatchDatasets

Returns the comment specific to the system.

Example: S(end).comment

Returns the currency of the simulation results.

Example: S(end).currencyOutput

Returns the currency of the monetary parameters in the system.

Example: S(end).currencyParam

Returns a DatasetInSystem class with the datasets available for a system.

Example: S(end).datasets

Returns the identifier number of the system.

Example: S(end).ID

Returns the main income definition.

Example: S(end).headDefInc

Returns the name of the system.

Example: S(end).name

Returns the order of the system in the spine.

Example: S(end).order

Returns the specific Country class.

Example: S(end).parent

Returns a PolicyInSystem class with system policies.

Example: S(end).policies

Returns the access type of the system.

Example: S(end).private

Returns the year of a system.

Example: S(end).year

Object Functions

expand all

info returns basic information on System properties of type class.

Example: mod.countries('AT').systems(end).info()

Run simulation of a EUROMOD tax-benefit system. This method returns a Simulation class containing simulation datasets and other simulation information. Run simulations specifying 2 required input arguments: the dataset, and the dataset name.

Example: mod.countries('SE').systems('SE_2021').run(data,'SE_2021_b1')

Output Arguments

collapse all

A class array with the Country default systems.

References

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

Extended Capabilities

See Also

Introduced in R2023a