This section describes the stocks (statistical data) file that Standard HyperAdmin expects as input.
Please note the following requirements for the input data file:
|
Following sections describe the expected format (sheets, columns and possible values) for the version 2 of this data.xls
"stocks" file.
Table 13.1 provides an example for this mandatory sheet in the data v2 input xls file.
VERSION | TIME_ENABLED |
---|---|
2 | TRUE |
This sheet aims at identifying the version of the format of this data file. Currently (2010-2011), only the value 2 is possible for the VERSION
column.
The expected value for the TIME_ENABLED
column is a boolean: only TRUE or FALSE values are possible:
The TRUE value shows that values are available for the sames labels of indicators at several dates: for example, the population in 2000, the population in 2002.
The FALSE value shows that each indicator is given for a single date.
Table 13.2 provides an example for this mandatory sheet in the data v2 input xls file.
UT_ID | pop2000 | pop2002 | area2000 | gdp2000 | gdp2002 |
---|---|---|---|---|---|
AT111 | 1 | 15 | 2 | 7 | 10 |
AT112 | 3 | 16 | 4 | 8 | 11 |
AT113 | 5 | 17 | 6 | 9 | 12 |
This sheet must provide at least three columns: UT_ID
then at least two indicators identifiers (in HyperAtlas, there must be at least one numerator stock
and one denominator stock). The Table 13.2 shows five indicators identifiers: pop2000
, pop2002
, area2000
,
gdp2000
and gdp2002
. These identifiers must be described in the StockInfo sheet (see Section 13.1.8).
The UT_ID
column must provide the list of territorial units at the lowest rank (example, at NUTS 3 level) of the dataset. The units are referenced by their
identifiers that must match the given values in the associated structure.xls
input file.
Then, each other cell provides a value for the given indicator column at the given unit row. For example in Table 13.2, 17 is the value for pop2002
indicator in AT113
territorial unit.
Each cell must be valuated. Missing values are not accepted here. |
Table 13.3 provides an example for this optional sheet in the data v2 input xls file.
DEFAULT_NUM | DEFAULT_DEN |
---|---|
pop | area |
This sheet aims at providing a default indicator to be selected in HyperAtlas at startup for the denominator and for the numerator combo boxes. Expected values for both columns are valid indicators identifiers that must match two of those defined in the StockInfo sheet (see Section 13.1.8).
Table 13.4 provides an example for this mandatory sheet in the data v2 input xls file.
LABEL_ID | LANG_CODE | NAME | DESC |
---|---|---|---|
1 | EN | Total population | Total population in thousands |
1 | FR | Population totale | Population totale en milliers |
2 | EN | Area | Total area |
2 | FR | Superficie | Superficie totale |
3 | EN | GDP | Gross domestic product |
3 | FR | PIB | Produit intérieur brut |
4 | EN | GDP/Inhabitant | Gross domestic product per inhabitant |
4 | FR | PIB/Hab | PIB par habitant |
5 | EN | Density | Density of population |
5 | FR | Densité | Densité de population |
This sheet aims at providing the internationalized names and descriptions for the indicators and predefined ratios. The LABEL_ID
and LANG_CODE
provides indexes for this table: for a given label identifier there may be several available translations. Thus, the LABEL_ID = 1
is available in english (LANG_CODE = EN
) and french
(LANG_CODE = FR
) languages. In the StockInfo sheet, each indicator reference a label identifier. As several indicators may
be similarly named and described (when an indicator is valuated for several dates), these labels have been exported here.
The language identifier code must be a valid ISO Language Code. These codes are the lower-case, two-letter codes as defined by ISO-639. Nevertheless, the parser supports upper-cases. You can find a full list of these codes at a number of sites, such as: http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt (2011-03-16). |
Note that values in the LABEL_ID
column may be referenced from the StockInfo sheet (see Section 13.1.8)
and from the RatioStock sheet (see Section 13.1.7).
Table 13.5 provides an example for this optional sheet in the data v2 input xls file.
UT_ID | STOCK_ID | PROVIDER_ID |
---|---|---|
AT111 | pop2000 | 1 |
AT112 | pop2000 | 2 |
area | 2 | |
pop2002 | 1 |
This draft sheet aims at providing some basic metadata information for an indicator relatively or not to a territorial unit. Currently, only the source of data may be given as metadata.
For example in Table 13.5, the values of the pop2000
indicator identifier were retrieved from different sources for
regions AT111
and AT112
. On the contrary, all values for the area
indicator, whatever the unit is,
were provided by the same source. Idem for the pop2002
indicator.
The values in the PROVIDER_ID
column must match the identifiers that are given in the Provider sheet (see Table 13.6).
Likewise, the values in the STOCK_ID
column must match the identifiers that are defined in the StockInfo sheet (see Table 13.8).
Table 13.6 provides an example for this optional sheet in the data v2 input xls file.
PROVIDER_ID | NAME | CONTACT | URL |
---|---|---|---|
1 | Eurostat | toto@eurostat.eu | http://www.eurostat.eu |
2 | INSEE | tata@insee.fr | http://www.insee.fr |
This sheet aims at providing the list of data providers. Their different ids are referenced from the Metadata sheet.
Table 13.7 provides an example for this optional sheet in the data v2 input xls file.
RATIO_ID | LABEL_ID | NUM_ID | DEN_ID | VALIDITY_START | VALIDITY_END |
---|---|---|---|---|---|
1 | 4 | gdp2000 | pop2000 | 2000 | 2000 |
2 | 4 | gdp2002 | pop2002 | 2002 | 2002 |
3 | 5 | pop2000 | area2000 | 2000 | 2000 |
4 | 5 | pop2002 | area2000 | 2002 | 2002 |
This sheet aims at defining relevant ratios for the HyperAtlas "ratio" combo box parameter. Table 13.7 shows the example of two such predefined ratios, each of them for two different dates:
the GDP/Inhabitant:
in 2000 (second line)
in 2002 (third line)
The density of population:
in 2000 (fourth line)
in 2002 (fifth line)
Each value in the RATIO_ID
column must be unique. Doublons will overwrite the previous found value.
Note that the LABEL_ID
references the sames labels for the given pairs of numerator/denominator at different dates (4
for lines 2 and 3, 5
for lines 4 and 5).
These labels identifiers must be set in theLabel sheet (see Section 13.1.4).
The values in the NUM_ID
column and the values in the DEN_ID
column must match the identifiers of indicators
that are defined in the StockInfo sheet (see Section 13.1.8).
The values in the VALIDITY_START
column will only be considered if the value of the TIME_ENABLED
column in the About sheet is TRUE
(see Section 13.1.1).
Then, one relevant ratio can be chosen in HyperAtlas for different dates.
Identically for the values in the VALIDITY_END
column. Though VALIDITY_START
and VALIDITY_END
columns are designed to handle time intervals, setting the same value in both columns makes the ratio associated to a timestamp.
Table 13.8 provides an example for this mandatory sheet in the data v2 input xls file.
STOCK_ID | LABEL_ID | MEASURE_UNIT | VALIDITY_START | VALIDITY_END | VISIBLE_FLAG |
---|---|---|---|---|---|
pop2000 | 1 | *1000 | 2000 | 2000 | TRUE |
pop2002 | 1 | *1000 | 2002 | 2002 | TRUE |
area2000 | 2 | km2 | 2000 | 2000 | TRUE |
gdp2000 | 3 | euros | 2000 | 2000 | TRUE |
gdp2002 | 3 | euros | 2002 | 2002 | TRUE |
This sheet mainly aims at providing the identifiers of the indicators of the dataset. Here are a short description for each column of this sheet:
STOCK_ID
: each value in this column must be unique. Any doublon will overwrite the previous found identical value. This column lists the
identifiers of the indicators that are referenced in the other sheets. Note that several indicators may be associated to the same label (lines 2 and 3 for example), though they exist
to distinguish the values of the population in 2000 and 2002.
LABEL_ID
: each value in this column must reference an identifier defined in the Label sheet (see Section 13.1.4).
MEASURE_UNIT
: simply provides the unit of measure for this indicator.
VALIDITY_START
: shows the start date of validity for this indicator. This field will only be considerated if the value of the TIME_ENABLED
column in the About sheet is TRUE
(see Section 13.1.1 and Important note about expected date format).
VALIDITY_END
: shows the end date of validity for this indicator. VALIDITY_START
and VALIDITY_END
fields
are able to manage time intervals, but they can be used to associate a timestamp to the current stock: just write the same value in both cells (please see Important note about expected date format).
VISIBLE
: this field acts like a flag, a boolean is expected for the values of this column. A TRUE
value shows that this indicator will be available
in the numerator and in the denominator combo boxes of HyperAtlas parameters panel. A FALSE
value may be usefull to define relevant ratios whose indicators have no reason to be available in the
numerator and denominator combo boxes. For example, the life expectancy pre-defined ratio considers indicators that have no sense out of this compute.