(EDGAR / v5)

Description

EDGAR database

Yaml arguments

The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:

Optional arguments

dir: (optional):

Path to the corresponding component. This value is used if not provided in parameters

accepted type: str

file: (optional):

File format in the given directory. This value is used if not provided in parameters

accepted type: str

varname: (optional):

Variable name to use to read data filesinstead of the parameter name if different to the parameter name

accepted type: str

file_freq: (optional):

Temporal frequency to fetch files

accepted type: str

split_freq: (optional)

Force splitting the processing at a given frequency different to file_freq

accepted type: str

closest_year: (optional): False

If the correct year is not available, use the closest one

accepted type: bool

truncated: (optional): False

If the domain is not global

accepted type: bool

Yaml template

Please find below a template for a Yaml configuration:

 1datastream:
 2  plugin:
 3    name: EDGAR
 4    version: v5
 5    type: datastream
 6
 7  # Optional arguments
 8  dir: XXXXX  # str
 9  file: XXXXX  # str
10  varname: XXXXX  # str
11  file_freq: XXXXX  # str
12  split_freq: XXXXX  # str
13  closest_year: XXXXX  # bool
14  truncated: XXXXX  # bool