-
Notifications
You must be signed in to change notification settings - Fork 1
/
03_SWS_resources.Rmd
147 lines (98 loc) · 5.38 KB
/
03_SWS_resources.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# SWS Resources {#resources }
This section enclose a detailed description of all the auxiliary resources needed by the modules to accomplish their calculation. It includes definition of code lists, used to define the various dimensions of data sets, and data tables.
## Code Lists
Code lists describe the dimensions that compose the different datasets, they are designed by the users to store analytical results from SWS modules. Each dataset have a set of codes and their associated description, thus Codelists are used within different sets for the sake of standardization, visualization and metadata associated to each dimentions. \
The code lists that describe `Trade Indices Numbers` dataset are the following :
- `GeographicAreaM49` : Represent the spatial scale, it is composed by countries territories, , regional aggregates, regional special groups aggregates, global aggregates.
- `measuredElementTrade ` : Represent the different element calculated by the plugin through the methodology mentioned above.
- `measuredItemCPC ` : Those items wants to take measure of production. For example, commodities and commodity groups produced by a country;
- `timePointYears` : The time unit (year) data is displayed for.
## Data Tables {#datatables}
Datatables are flexible tool made available inside the Statistical Working System to store a wide range of useful information. They indeed provide a strong support to R module to record countries and items groups composition, to map conversion factors and to store different type of data.
Variable names (column names) of datatables are more flexible compared to those of datasets, they can accommodate all kind of names and are not strictly constrained by code lists or by the domain in which they are stored.
Below a detailed description of all the datatable used in the Value of Production module.
### TI - Base Year
* **Datatable :** `ti_base_year`
* **Domain :** `Trade`
* **Usage :** Used to define the base year. The plugin will calculate the three-year base period around the specified value.
<br>
|Field|Description|
|:------------------|:--------------------------------------------------------------|
|Base Year|Base Year of the Trade Indices Numbers Plugin|
### TI - Country List {#countrytab}
* **Datatable :** `ti_country_list`
* **Domain :** `Trade`
* **Usage :** Contain the list of countries for which trade indices are calcualted.
<br>
|Field|Description|
|:------------------|:--------------------------------------------------------------|
|Country Name|Extended name of the Country|
|M49 Code|Area Code M49|
|Start Year|Stasting validity year|
|End Year|Ending validity year|
<br>
### TI - Item List {#itemtab}
* **Datatable :** `ti_item_list`
* **Domain :** `Trade`
* **Usage :** Used to define the items list for which the trade indices are calculated .
<br>
|Field|Description|
|:------------------|:--------------------------------------------------------------|
|Item Name|Name of the item|
|CPC code|Corresponding CPC item code|
<br>
### TI - Aggregation Table {#aggregationtab}
* **Datatable :** `ti_aggregation_table`
* **Domain :** `Trade`
* **Usage :** Used to define the aggregate composition for regions and items.
<br>
|Field|Description|
|:------------------|:--------------------------------------------------------------|
|Variable Type| Type of group variable (Area/Item)|
|Variable Group code| FAOSTAT group code|
|Variable Code| Code of single item/country|
|Variable Element| Specific element for which the group composition may change. If not specified it will be consideres as the default composition|
|Factor| Factor for aggregation|
|Variable Group Name| Name of the Group|
|Variable Name| Name of the single item/country|
<br>
### TI - area not FOB/CIF multipliers {#FOBCIFtab}
* **Datatable :** `ti_fob_cif_multipliers`
* **Domain :** `Trade`
* **Usage :** Define Area for which FOB/CIF Multipliers must be applied.
<br>
|Field|Description|
|:------------------|:--------------------------------------------------------------|
|Area Code |FCL Code, can be omitted|
|Area Code M49 |M49 code|
|Start Year |Starting year of validity period|
|End Year |Ending year of validity period|
|Multiplier |Multiplier to apply|
<br>
### TI - Code conversion table
* **Datatable :** `ti_code_conversion`
* **Domain :** `Trade`
* **Usage :** Map correct CPC code specified in TI - Item List, with the wrong one used in SWS.
<br>
|Field|Description|
|:------------------|:--------------------------------------------------------------|
|FAOSTAT Code |Correct CPC Code used in FAOSTAT|
|SWS Code |CPC Code used in SWS that contain data|
|Note |Describing notes|
### TI - LOG
* **Datatable :** `ti_log`
* **Domain :** `Trade`
* **Usage :** Provide a LOG history of plugin runs.
<br>
|Field|Description|
|:------------------|:--------------------------------------------------------------|
|User |User email of the user that run the plugin|
|Execution Date |Date of the execution|
|Base Year Parameter |Base year selected|
|Years Computed |Years range of the plugin run|
|Source input data |Source of Input data|
|Import/Export Filter Parameter |Filter selection|
|Lines writed |Data points writed by the plugin|
|Lines omitted |Data points not updated by the plugin|
|Lines discarded |Data points not writed by the plugin|
|Time Elapsed |Total time to complete the Task|