Difference between revisions of "Time Series"

From Gcube Wiki
Jump to: navigation, search
m (→‎Grouping)
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
This is the user guide to Time Series portlet.
 +
If you are looking for the developer guide please refer to this [[Time_Series_(development)|page]].
 +
 
= Time Series elaboration cycle =
 
= Time Series elaboration cycle =
 
Time Series elaboration cycle is made up of four phases:
 
Time Series elaboration cycle is made up of four phases:
Line 5: Line 8:
 
# '''Time Series Curation''': TS is corrected and cleaned.
 
# '''Time Series Curation''': TS is corrected and cleaned.
 
# '''Time Series Manipulation''': TS is elaborated depending on user need.
 
# '''Time Series Manipulation''': TS is elaborated depending on user need.
−
# '''Time Series Publication''': TS come available for the community.
+
# '''Time Series Publication''': TS is made available to the community.
  
 
[[Image:ts_cycle.png|frame|none|Time Series elaboration cycle]]
 
[[Image:ts_cycle.png|frame|none|Time Series elaboration cycle]]
  
 
= Time Series Import  =
 
= Time Series Import  =
 +
 +
== CSV import wizard ==
 
Through a wizard interface a Time Series, represented as a csv file(RFC 4180) is imported through in the system.
 
Through a wizard interface a Time Series, represented as a csv file(RFC 4180) is imported through in the system.
  
−
CSV file can either be imported by uploading the file from the user file system or from the user workspace.
+
CSV files can either be imported by uploading the file from the user file system or from the user workspace.
  
 
Once a CSV file has been loaded it is possible to select some parameters relative to the uploaded file:  
 
Once a CSV file has been loaded it is possible to select some parameters relative to the uploaded file:  
Line 30: Line 35:
  
 
In order to made the system accept the current configuration it is necessary to verify the whole file by clicking on the “Check configuration” button. The system will check then the entire CVS for RFC 4180 compliance.
 
In order to made the system accept the current configuration it is necessary to verify the whole file by clicking on the “Check configuration” button. The system will check then the entire CVS for RFC 4180 compliance.
−
 
−
If there is any error it will be possible to see which rows are wrong and, in case, to decide to skip them in the importing phase.
 
  
 
[[Image:ts_import_wizard_errors.png|frame|none|Time Series import wizard: errors]]
 
[[Image:ts_import_wizard_errors.png|frame|none|Time Series import wizard: errors]]
  
−
Once the importing phase is completed it will be possible to define metadata for the current imported CSV.
+
If there is any error it will be possible to see which rows are wrong and, in case, to decide to skip them in the importing phase. Currently the maximum number of errors displayed is fixed to 50.
 +
 
 +
[[Image:ts_import_wizard_errors_window.png|frame|none|Time Series import wizard: errors window]]
 +
 
 +
The CSV can be normalized during the import phase.
 +
The normalization operation require the following parameters:
 +
* the normalized column name
 +
* the value column name
 +
* which columns normalize
 +
 
 +
[[Image:ts_import_wizard_normalize.png|frame|none|Time Series import wizard: normalization configuration]]
 +
 
 +
For example, the following CSV:
 +
{| border="1" cellpadding="4" cellspacing="0"
 +
!Country !! 1998 !! 1999 !! 2000
 +
|-
 +
| Italy || 123 || 456 || 160
 +
|-
 +
| France || 742 || 788 || 122
 +
|}
 +
 
 +
when normalized setting as normalized column name 'Year', as value column name 'Quantity' and with columns to normalize '1998', '1999' and '2000' is transformed in:
 +
{| border="1" cellpadding="4" cellspacing="0"
 +
!Country !! Year !! Quantity
 +
|-
 +
| Italy || 1998 || 123
 +
|-
 +
| Italy || 1999 || 456
 +
|-
 +
| Italy || 2000 || 160
 +
|-
 +
| France || 1998 || 742
 +
|-
 +
| France || 1999 || 788
 +
|-
 +
| France || 2000 || 122
 +
|}
 +
 
 +
 
 +
Once the configuration phase is completed it will be possible to define metadata for the current imported CSV.
  
 
The last step consists of a CSV creation into the system. During the creation a loading bar will indicate the overall progress of the operation.
 
The last step consists of a CSV creation into the system. During the creation a loading bar will indicate the overall progress of the operation.
Line 102: Line 144:
 
Note: It won't be possible to discard the changed made in editing mode.
 
Note: It won't be possible to discard the changed made in editing mode.
  
 +
During the Error editing phase is not possible to change the columns configuration nor to delete a column.
  
 
== Editing and Column removal ==
 
== Editing and Column removal ==
Line 110: Line 153:
  
 
= Time Series Manipulation =
 
= Time Series Manipulation =
 +
[[Image:ts_operations.png|frame|Time Series applied operations]]
 
A Time Series can be manipulate through the following operations:
 
A Time Series can be manipulate through the following operations:
  
Line 118: Line 162:
 
* '''Aggregation''': values aggregation by column selection.
 
* '''Aggregation''': values aggregation by column selection.
  
−
Once the single operation is applied is possible to save the TS or discard the operation. (except for the union operation)
+
When one or more operations are applied is possible to save the modified TS.
 +
In any moment is possible to discard the last applied operation or all operations.
  
−
At any time the status bar indicate which operation is applied.
+
The status bar indicates which operations are applied.
−
[[Image:ts_operation.png|frame|none|Time Series applied operation]]
+
 
 +
==Time Series History==
 +
The Time Series system register the history of all main operations applied between the different TS versions.
 +
 
 +
To show the history click on history button.
 +
[[Image:ts_history.png|frame|none|Time Series history]]
 +
 
 +
For each TS version a list of all applied operations is showed. An availability status indicates if the version selected version can be opened.
  
 
== Filtering ==
 
== Filtering ==
Line 138: Line 190:
 
The full operation is executed by using a Wizard interface.
 
The full operation is executed by using a Wizard interface.
  
−
First step consist of selecting the TS to merge with the one currently open. Once step first is done, system checks for compatibility.
+
First step consist of selecting the TS to merge with the one currently open. The system show only the list of compatible Time Series.
  
−
In the current union operation we define two ts compatibles if they have the same number of columns and these columns match for type and order.
+
Two TS are compatible if all fist TS columns are mappable, without considering the order, onto the second TS columns.
 +
 
 +
Two columns ''A'' and ''B'' are mappable if one of those case is matched:
 +
* ''A'' and ''B'' are value or attribute columns and ''A'' type is equals to ''B'' type (e.g. ''A'' and ''B'' are text columns)
 +
* ''A'' and ''B'' are dimension columns and both referrer to the same key family and key.
 +
 
 +
Selected the target TS is possible to define the columns mapping.
  
 
[[Image:ts_union.png|frame|none|Time Series union]]
 
[[Image:ts_union.png|frame|none|Time Series union]]
 +
 +
There are three columns:
 +
* ''Labels'' which defines the new TS columns labels
 +
* the list of first TS columns
 +
* the list of second TS columns
 +
 +
Choosing a column from the first TS only the compatible ones are showed for the second TS.
 +
 +
Completed the mapping configuration the union operation is applied.
  
 
== Denormalization ==
 
== Denormalization ==
Line 163: Line 230:
 
|}
 
|}
  
−
when denormalized by the attribute Year and the value Quantity become:
+
when denormalized by the attribute 'Year' and the value 'Quantity' is transformed in:
 
{| border="1" cellpadding="4" cellspacing="0"  
 
{| border="1" cellpadding="4" cellspacing="0"  
 
!Country !! 1998 !! 1999
 
!Country !! 1998 !! 1999
Line 173: Line 240:
  
 
== Grouping ==
 
== Grouping ==
−
Grouping is the facility for combining multiple observations. It is performed by relying on the Dimension columns of the time series. Besides selecting the Dimension of interest, the user is requested to specify which is the quantity of the observation to be aggregated and which is the aggregation function, e.g. sum, average.  
+
Grouping is the facility for combining multiple observations. It is performed by relying on the Dimension columns of the time series. Besides selecting the Dimension of interest, the user is requested to specify which is the aggregation function, e.g. sum, average.  
  
 
[[Image:ts_grouping.png|frame|Time Series grouping]]
 
[[Image:ts_grouping.png|frame|Time Series grouping]]
  
−
For instance, a time series having observation on a country-level granularity can be grouped into a time series having observation on a continent-based granularity by summing the national observations.
+
For instance, a time series of observations on a country-level granularity can be grouped into a time series of observations on a continent-based granularity by summing the national observations.
  
 
For example, the following time series:
 
For example, the following time series:
Line 192: Line 259:
 
|}
 
|}
  
−
when grouped by the dimension 'Country' as 'Continent' with the value 'Quantity' and by using the 'sum' function is transformed in:
+
when grouped by the dimension 'Country' as 'Continent' using the 'sum' function is transformed in:
 
{| border="1" cellpadding="4" cellspacing="0"  
 
{| border="1" cellpadding="4" cellspacing="0"  
 
!Country !! Year !! Quantity
 
!Country !! Year !! Quantity
Line 203: Line 270:
 
== Aggregation ==
 
== Aggregation ==
  
−
Aggregation is the facility for combining multiple observations. Similarly to the Grouping it is performed on the Dimension columns, the semantic is to not consider the different values of the selected Dimension. Besides selecting the Dimension of interest, the user is requested to specify which is the quantity of the observation to be aggregated and which is the aggregation function, e.g. sum, average.  
+
Aggregation is the facility for combining multiple observations. Similarly to the Grouping it is performed on the Dimension columns, the semantic is to not consider the different values of the selected Dimension. Besides selecting the Dimension of interest, the user is requested to specify which is the aggregation function, e.g. sum, average.  
  
 
[[Image:ts_aggregation.png|frame|Time Series aggregation]]
 
[[Image:ts_aggregation.png|frame|Time Series aggregation]]
  
−
For instance, a time series having observation on a country-level granularity can be grouped into a time series having no country-related information by summing the per country observations.
+
For instance, a time series of observations on country-level granularity can be grouped into a time series having no country-related information by summing the per country observations.
  
−
For example the follow time series:
+
For example, the following time series:
 
{| border="1" cellpadding="4" cellspacing="0"  
 
{| border="1" cellpadding="4" cellspacing="0"  
 
!Country !! Year !! Quantity
 
!Country !! Year !! Quantity
Line 222: Line 289:
 
|}
 
|}
  
−
aggregated by the dimension Country with the value Quantity using the sum function become:
+
when aggregated by the dimension 'Country' by using the 'sum' function it is transformed in:
 
{| border="1" cellpadding="4" cellspacing="0"  
 
{| border="1" cellpadding="4" cellspacing="0"  
 
!Country !! Year !! Quantity
 
!Country !! Year !! Quantity
Line 232: Line 299:
  
 
== Time Series publishing ==
 
== Time Series publishing ==
−
A TS can be published either at VO or VRE level at anytime.
+
A TS can be published either at VO or VRE level.
  
 
[[Image:ts_publishing.png|frame|none|Time Series publishing]]
 
[[Image:ts_publishing.png|frame|none|Time Series publishing]]
  
 
== Time Series Export as CSV==
 
== Time Series Export as CSV==
−
A TS can be exported in the user workspace using CSV format.
+
A TS can be exported to the user workspace using CSV format.
  
−
First step consists of the configuration of the csv to create: char-set selection, field separator, column selection and so on.
+
The first step consists of the configuration of the csv to create: char-set selection, field separator, column selection and so on.
  
 
[[Image:ts_export.png|frame|none|Time Series export as CSV]]
 
[[Image:ts_export.png|frame|none|Time Series export as CSV]]
  
−
Second step asks for the basket in which save the CSV file.
+
The second step asks for the basket in which to save the CSV file.
  
 
= Workspace integration =
 
= Workspace integration =
−
TS can be saved as items in the user Workspace  
+
TS can be saved as items in the user Workspace.
  
 
In order to open a previously workspace saved TS, or from another user, click on the “Load from workspace” button.
 
In order to open a previously workspace saved TS, or from another user, click on the “Load from workspace” button.

Latest revision as of 13:13, 6 October 2011

This is the user guide to Time Series portlet. If you are looking for the developer guide please refer to this page.

Time Series elaboration cycle

Time Series elaboration cycle is made up of four phases:

  1. Time Series Import: a TS is imported through in the system though a CSV file.
  2. Time Series Curation: TS is corrected and cleaned.
  3. Time Series Manipulation: TS is elaborated depending on user need.
  4. Time Series Publication: TS is made available to the community.
Time Series elaboration cycle

Time Series Import

CSV import wizard

Through a wizard interface a Time Series, represented as a csv file(RFC 4180) is imported through in the system.

CSV files can either be imported by uploading the file from the user file system or from the user workspace.

Once a CSV file has been loaded it is possible to select some parameters relative to the uploaded file:

  • Character Encoding
  • the file header flag
  • field separator
  • columns to import/exclude

The configuration shows a CSV sample based on the selected parameters. This sample is limited to the first 50 rows.

Time Series import wizard: CSV file configuration

Through the sample grid, it is possible to select which columns a user wants to exclude from the importing.

Time Series import wizard: column selection

In order to made the system accept the current configuration it is necessary to verify the whole file by clicking on the “Check configuration” button. The system will check then the entire CVS for RFC 4180 compliance.

Time Series import wizard: errors

If there is any error it will be possible to see which rows are wrong and, in case, to decide to skip them in the importing phase. Currently the maximum number of errors displayed is fixed to 50.

Time Series import wizard: errors window

The CSV can be normalized during the import phase. The normalization operation require the following parameters:

  • the normalized column name
  • the value column name
  • which columns normalize
Time Series import wizard: normalization configuration

For example, the following CSV:

Country 1998 1999 2000
Italy 123 456 160
France 742 788 122

when normalized setting as normalized column name 'Year', as value column name 'Quantity' and with columns to normalize '1998', '1999' and '2000' is transformed in:

Country Year Quantity
Italy 1998 123
Italy 1999 456
Italy 2000 160
France 1998 742
France 1999 788
France 2000 122


Once the configuration phase is completed it will be possible to define metadata for the current imported CSV.

The last step consists of a CSV creation into the system. During the creation a loading bar will indicate the overall progress of the operation.

CSV Data Handling

Once the CSV has been created it will be possible to open it for examining its content. (note that the content can be ordered at this time)

A CSV can be exported directly into the Workspace, see TS CSV export section.

In order to start the curation phase it is necessary to transform the imported CSV into a TS by clicking on the button “Create Time Series”.

CSV view

Time Series Curation

The Curation phase allows to curate a TS by linking it to the reference data and consequently correcting eventual errors.

Each TS column can belong to the following types:

  • Dimension: an attribute of the observation whose values come from a controlled vocabulary, key family or reference data;
  • Attribute: an attribute of the observation whose values are freely defined;
  • Value: the observation (quantitative value) captured by the time series;

In order to define a curated TS it is necessary to cure all the columns. The yet cured columns are shown by using a green filled circle in the column header. The not yet cured columns are shown by using a red filled circle in the column header.

Column Curation

In order to start curating a column, user should right click on the column header and select the item “Edit properties”. A new panel will appear for the column property editing.

Time Series Curation: edit panel

This panel allows to rename a column by editing its label.

By using the radio selection buttons it is possible to select the column type.

For the attribute types and values it is possible to select the data type: Text, Integer, Float, Date, Time, Boolean, Timestamp.

For the type Column it is possible to edit the family key and key value to associate. By using the check errors button it is possible to know how many rows contain errors associated to that dimension. By using the sample button it will be show a sample of the values with the reference data referred.

For each column it is possible to exploit the GUESS tool, which will try to guess which reference data has to be associated to the column by using the reference date present into the system. For each proposed dimension the errors number will be automatically calculated.

Time Series Curation: guess window

Once the configuration is done, it is either possible to save or discard the changes.

If the column has been associated to a dimension and, there are some rows which contain errors, the system enters in a mode called error editing.

Error editing

In this modality only the containing error rows are shown.

Time Series Curation: error edit

The row error can be due to the following reasons:

  • the value cannot find its equivalent among reference data values
  • the value finds more than a correspondence among reference data values

These two types of errors will be shown by using different colors, red for the first one, yellow for the second one.

System allow to edit the values for each single column. If the cell belong to type dimension, a popup will appear with the list of possible values to associate to it.

Time Series Curation: edit value

It is possible to discard all the changes going back to the previous column configuration any time.

Once all the rows are corrected the system will ask to the user to save the changes applied so far.

Note: It won't be possible to discard the changed made in editing mode.

During the Error editing phase is not possible to change the columns configuration nor to delete a column.

Editing and Column removal

It is possible to edit single column values at any time. In order to remove a whole column from the TS, right click on the column header you want to remove and select “Remove column”.

Curation Closing

Once all column have been curated it will be possible to close the Curation publishing the TS in the Curated TS list.

Time Series Manipulation

Time Series applied operations

A Time Series can be manipulate through the following operations:

  • Filtering: filter the TS by Column or Values criteria.
  • Union:Union of two Time Series.
  • Denormalization: Denormalization of TS Values.
  • Grouping: grouping of values by column selection.
  • Aggregation: values aggregation by column selection.

When one or more operations are applied is possible to save the modified TS. In any moment is possible to discard the last applied operation or all operations.

The status bar indicates which operations are applied.

Time Series History

The Time Series system register the history of all main operations applied between the different TS versions.

To show the history click on history button.

Time Series history

For each TS version a list of all applied operations is showed. An availability status indicates if the version selected version can be opened.

Filtering

It is possible to filter the TS by selecting the filtering conditions to apply to the TS Column Values.

Clearly condition types vary depending on the column type:

  • for each column type is possible to apply conditions based on compound expressions: filtering by range;
Time Series filtering by range
  • for each column of type dimension is possible to define a set of acceptable values: filtering by value.
Time Series filtering by value

Union

The Union operation merges two TS in one single TS.

The full operation is executed by using a Wizard interface.

First step consist of selecting the TS to merge with the one currently open. The system show only the list of compatible Time Series.

Two TS are compatible if all fist TS columns are mappable, without considering the order, onto the second TS columns.

Two columns A and B are mappable if one of those case is matched:

  • A and B are value or attribute columns and A type is equals to B type (e.g. A and B are text columns)
  • A and B are dimension columns and both referrer to the same key family and key.

Selected the target TS is possible to define the columns mapping.

Time Series union

There are three columns:

  • Labels which defines the new TS columns labels
  • the list of first TS columns
  • the list of second TS columns

Choosing a column from the first TS only the compatible ones are showed for the second TS.

Completed the mapping configuration the union operation is applied.

Denormalization

The facility to display multiple and related observations on the same row. Denormalization is performed by selecting the attribute and the value of interest. The result is that all the observations sharing common values on the rest of columns are merged into a single row containing as column name the attribute value and as value the relative value.

Time Series denormalization

For example, the following time series:

Country Year Quantity
Italy 1998 123
Italy 1999 456
France 1998 742
France 1999 788

when denormalized by the attribute 'Year' and the value 'Quantity' is transformed in:

Country 1998 1999
Italy 123 456
France 742 788

Grouping

Grouping is the facility for combining multiple observations. It is performed by relying on the Dimension columns of the time series. Besides selecting the Dimension of interest, the user is requested to specify which is the aggregation function, e.g. sum, average.

Time Series grouping

For instance, a time series of observations on a country-level granularity can be grouped into a time series of observations on a continent-based granularity by summing the national observations.

For example, the following time series:

Country Year Quantity
Italy 1998 123
Italy 1999 456
France 1998 742
France 1999 788

when grouped by the dimension 'Country' as 'Continent' using the 'sum' function is transformed in:

Country Year Quantity
Europe 1998 865
Europe 1999 1244

Aggregation

Aggregation is the facility for combining multiple observations. Similarly to the Grouping it is performed on the Dimension columns, the semantic is to not consider the different values of the selected Dimension. Besides selecting the Dimension of interest, the user is requested to specify which is the aggregation function, e.g. sum, average.

Time Series aggregation

For instance, a time series of observations on country-level granularity can be grouped into a time series having no country-related information by summing the per country observations.

For example, the following time series:

Country Year Quantity
Italy 1998 123
Italy 1999 456
Tunisia 1998 742
Tunisia 1999 788

when aggregated by the dimension 'Country' by using the 'sum' function it is transformed in:

Country Year Quantity
All 1998 865
All 1999 1244

Time Series publishing

A TS can be published either at VO or VRE level.

Time Series publishing

Time Series Export as CSV

A TS can be exported to the user workspace using CSV format.

The first step consists of the configuration of the csv to create: char-set selection, field separator, column selection and so on.

Time Series export as CSV

The second step asks for the basket in which to save the CSV file.

Workspace integration

TS can be saved as items in the user Workspace.

In order to open a previously workspace saved TS, or from another user, click on the “Load from workspace” button.

Retrieved from "https://wiki.gcube-system.org/index.php?title=Time_Series&oldid=12646"