iode.Comments

class iode.Comments

IODE Comments database.

Parameters:

filepath: str, optional: file containing the IODE comments to load.

Returns:

Comments

Examples

>>> from iode import comments, SAMPLE_DATA_DIR
>>> comments.load(f"{SAMPLE_DATA_DIR}/fun.cmt")
>>> len(comments)
317
>>> comments            
Workspace: Comments
nb comments: 317
filename: ...\tests\data\fun.cmt

 name                                                  comments
ACAF        Ondernemingen: ontvangen kapitaaloverdrachten.
ACAG        Totale overheid: netto ontvangen kapitaaloverdrachten.
AOUC        Kost per eenheid produkt.
AQC         Kost per eenheid produkt: kapitaal en arbeid.
BENEF       Ondernemingen: niet-uitgekeerde winsten.
...         ...
ZF          Indexeringscoëfficiënt voor de lonen in de private sector.
ZJ          Indexeringscoëfficiënt voor de sociale uitkeringen, vertraagd in de periode 1984-1988, voor de
            verrekening van de indexsprongen bij de vervangingsinkomens (1984, 1985, 1987).
ZKF         Bezettingsgraad van de produktiecapaciteit.
ZX          Saut d'index (correction en %)
ZZ_         Marktsector (ondernemingen en zelfstandigen): loonquote (gemiddelde 1954-94).

Attributes:

filename: str
description: str

Methods

`clear`(self)	Delete all objects from the current database.
`copy`(self)	Create a copy of an IODE database.
`copy_from`(self, input_files[, objects_names])	Copy (a subset of) objects from the input file(s) 'input_files' into the current database.
`from_series`(self, s)	Copy the pandas Series s into the IODE Comments database.
`get_names`(self[, pattern])	Returns the list of objects names given a pattern.
`is_copy_subset`(self)	Whether or not the present object represents of a subset of a global IODE database and if the IODE objects of the subset represent deep copies of the IODE objects from the global IODE database.
`is_subset`(self)	Whether or not the present object represents a subset of a global IODE database.
`load`(self, filepath)	Load objects stored in file 'filepath' into the current database.
`merge`(self, other[, overwrite])
`merge_from`(self, input_file)	Merge all objects stored in the input file 'input_file' into the current database.
`remove`(self, names)	Delete the object(s) named 'names' from the current database.
`rename`(self, old_name, new_name)	Rename an object of the database.
`save`(self, filepath)	Save objects of the current database into the file 'filepath'.
`search`(self, pattern[, word, ...])	Return a list of all objects from the current database having a specific pattern in their names or LEC expression, comment...
`to_series`(self)	Create a pandas Series from the current Comments database.

__init__(*args, **kwargs)

Methods

`__init__`(args, *kwargs)
`clear`(self)	Delete all objects from the current database.
`copy`(self)	Create a copy of an IODE database.
`copy_from`(self, input_files[, objects_names])	Copy (a subset of) objects from the input file(s) 'input_files' into the current database.
`from_series`(self, s)	Copy the pandas Series s into the IODE Comments database.
`get_names`(self[, pattern])	Returns the list of objects names given a pattern.
`is_copy_subset`(self)	Whether or not the present object represents of a subset of a global IODE database and if the IODE objects of the subset represent deep copies of the IODE objects from the global IODE database.
`is_subset`(self)	Whether or not the present object represents a subset of a global IODE database.
`load`(self, filepath)	Load objects stored in file 'filepath' into the current database.
`merge`(self, other[, overwrite])
`merge_from`(self, input_file)	Merge all objects stored in the input file 'input_file' into the current database.
`remove`(self, names)	Delete the object(s) named 'names' from the current database.
`rename`(self, old_name, new_name)	Rename an object of the database.
`save`(self, filepath)	Save objects of the current database into the file 'filepath'.
`search`(self, pattern[, word, ...])	Return a list of all objects from the current database having a specific pattern in their names or LEC expression, comment...
`to_series`(self)	Create a pandas Series from the current Comments database.

Attributes

`description`	description: str
`filename`	filename: str
`names`	names: List[str]
`series`	series: Series