T-GUI-Overview.qmd

# Graphical User Interface (GUI): Overview {.unnumbered #t-gui-overview}

## In this chapter

This chapter provides general information about using the Graphical User Interface (GUI). Specific indications related to a given algorithm (X13-ARIMA, Tramo-seats, Benchmarking...) are displayed in the relevant chapters, listed [here](#part-A).

Contents:

- Available algorithms
- Installation and launch 
- Importing data
- General window and menu structure 

Additional chapters related to GUI features, provide information on:

- [Data visualization and generic time series tools](#t-GUI-tstools)
- [Specific Seasonal Adjustement and Modelling features](#t-gui-sa)
- [Output: series, parameters and diagnostics](#t-gui-output)


### Available algorithms


::: {.panel-tabset .content-visible when-format="html"}

#### v2

The Graphical User Interface in the 2.x family gives access to:

- Seasonal adjustment [(SA) algorithms](#sa-chapter)

    + X13-ARIMA
    + TRAMO-SEATS
    + Direct-indirect SA comparisons

- Outlier detection (TERROR)

- Benchmarking

#### v3

The Graphical User Interface in the 3.x family gives access **in addition** to extended SA algorithms for [high-frequency data (HF)](#sa-hf).

:::


::: {.content-visible when-format="pdf"}

The Graphical User Interface in the 2.x family gives access to:

- Seasonal adjustment [(SA) algorithms](#sa-chapter)

    + X13-ARIMA
    + TRAMO-SEATS
    + Direct-indirect SA comparisons

- Outlier detection (TERROR)

- Benchmarking

The Graphical User Interface in the 3.x family gives access **in addition** to extended SA algorithms for [high-frequency data (HF)](#a-sa-hf).

:::


### Available Time Series tools

The Graphical User Interface in the 2.x and 3.x family give access to generic time series tools:

- Graphics
    + time domain
    + spectral analysis
- Tests
    + seasonality tests
    + autocorrelation, normality, randomness tests
    


## Installation Procedure

The installation procedure is detailed [here](#ind-inst-gui) in the introductory chapter of this book. Should you need more configuration details you will find specific [Sheets](https://github.com/TanguyBarthelemy/JD-Tutorials/tree/master/Sheets) in the JD-Tutorials [GitHub repository](https://github.com/TanguyBarthelemy/JD-Tutorials) 


###  Launching JDemetra+

To open an application, double click on *nbdemetra.exe* or *nbdemetra64.exe* depending on the system version (*nbdemetra.exe* for the 32-bit system version and *nbdemetra64.exe* for the 64-bit system version).

![**Launching JDemetra+**](All_images/RunningJDemetra.jpg)

If the launching of JDemetra+ fails, you can try the following operations:

- Check if Java SE Runtime Environment (JRE) is properly installed by typing in the following command in a terminal: 

```
java --version
```

- Check the logs in your home directory:

    + [%appdata%/.nbdemetra/dev/var/log/]{.path} for Windows;

    + [~/.nbdemetra/dev/var/log/]{.path}` for Linux and Solaris;

    + [~/Library/Application Support/.nbdemetra/dev/var/log/]{.path} for Mac OS X.

In order to remove a previously installed JDemetra+ version, the user should delete an appropriate JDemetra+ folder.


## Starting Window

::: {.content-visible when-format="html"}

On the image below click on the area that interests you:

<img src="All_images/Jd_mainwindow.png" usemap="#image_map">
<map name="image_map">
  <area alt="providers" title="Providers" href="#providers-window" coords="4,71,76,101" shape="rect">
  <area alt="workspaces" title="Workspaces" href="#workspace-window" coords="86,70,167,100" shape="rect">
  <area alt="result" title="Result" href="#results-panel-overview" coords="211,68,806,359" shape="rect">
  <area alt="topbar" title="Topbar menu" href="#topbar-menu" coords="29,1,680,29" shape="rect">
  <area alt="closing" title="Closing" href="close" coords="765,1,807,26" shape="rect">
</map>

<script src="resize.js"></script>
<script> initializeAndAdjust("image_map") </script>

::: {.image-map-caption}
**JDemetra+ default window**
:::

:::


::: {.content-visible when-format="pdf"}

![**JDemetra+ default window**](All_images/Jd_mainwindow.png)

:::

By default, on the left hand side of the window two panels are visible:

- The [*Workspace* panel](#workspace-window) stores the results generated by the software as well as settings used to create them;
- The [*Providers* panel](#providers-window) organises the imported raw data within each data provider;

The other key parts of the user interface are:

- The [application menu](#topbar-menu).
- A central empty zone for presenting the actual analyses further called the [Results panel](#results-panel-overview).



## Providers window {#providers-window}

![**The *Providers* window**](All_images/A_Ref5.jpg){.image}

By default, JDemetra+ supports the following data sources:

- JDBC;
- ODBC;
- SDMX;
- Excel spreadsheets;
- TSW (input files for the [TRAMO-SEATS-Windows application](https://www.bde.es/bde/en/secciones/servicios/Profesionales/Programas_estadi/Programas.html) by the Bank of Spain);
- TXT;
- USCB (input files for the [X-13-ARIMA-SEATS application](https://www.census.gov/srd/www/winx13/) by the U.S. Census Bureau);
- XML.

All standard databases (Oracle, SQLServer, DB2, MySQL) are supported by JDemetra+ via JDBC, which is a generic interface to many relational databases. Other providers can be added by users by creating plugins (see *Plugins* section in the [Tools](tools.html) menu).


### Import data {#import-data}

To import data from a given data source:

- click on this data source in the *Providers* window shown below
- choose *Open* option and specify the import details, such as a path to a data file. 

These details vary according to data providers. 

{{< video https://www.youtube.com/watch?v=KYBcKx1e8ys&pp=ygUUaW1wb3J0IGRhdGEgamRlbWV0cmE%3D >}}


::: {.panel-tabset .content-visible when-format="html"}

#### Spreadsheet

::: {.content-visible when-format="html"}

![**An example of importing process for the Excel file :**](All_images/Import_spreadsheet.gif)

::: 

The example below show how to import the data from an Excel file.

1.  From the *Providers* window **right-click** on the *Spreadsheets* branch and choose *Open* option.

    ![**Data provider available by default**](All_images/Aimage6.jpeg)

2.  The *Open data source* window contains the following options:

    + **Spreadsheet file** -- a path to access the Excel file.

    + **Data format** (or **Observartion format** in v3) -- the data format used to read dates and values. It includes three fields: *locale* (country), *date pattern* (data format, e.g. *yyyy-mm-dd*), *number pattern* (a metaformat of numeric value, e.g. 0.## represents two digit number).

    + **Frequency** -- time series frequency. This can be undefined, yearly, half-yearly, four-monthly, quarterly, bi-monthly, or monthly. When the frequency is set to undefined, JDemetra+ determines the time series frequency by analysing the sequence of dates in the file.

    + **Aggregation type** -- the type of aggregation (over time for each time series in the dataset) for the imported time series. This can be *None*, *Sum*, *Average*, *First*, *Last*, *Min* or *Max*. The aggregation can be performed only if the *frequency* parameter is specified. For example, when frequency is set to *Quarterly* and aggregation type is set to *Average*, a monthly time series is transformed to quarterly one with values that are equal to the one third of the sum of the monthly values that belong to the corresponding calendar quarter.

    + **Clean missing** <a id="clean-missing"></a> -- erases missing values at the start of the series.

    Next, in the *Source* section click the grey "..." button to open the file.

    ![**Data source window**](All_images/Aimage7.jpeg)

3.  Choose a file and click *OK*.

    ![**Choice of an Excel spreadsheet**](All_images/Aimage8.jpeg)

4.  The user may specify *Data format*, *Frequency* and *Aggregation type*, however this step is not compulsory. When these options are specified JDemetra+ is able to convert the time series frequency. Otherwise, the functionality that enables the time series frequency to be converted will not be available.

    ![**Options for importing data**](All_images/Aimage9.jpeg)

5.  The data are organized in a tree structure.

    ![**Dataset structure**](All_images/Aimage10.jpeg)

Once imported, your s is visible as a "node" structure

![**A structure of a dataset**](All_images/A_Ref6.jpg)

::: {.callout-caution title="Accepted formats"}

In v2, the formats `.xls` and `.xlsx` are accepted.

In v3, only the format `.xlsx` is accepted (`.xls` files are no longer supported).

:::


::: {.callout-note collapse="true" title="How to set-up your spreadsheet"}

- **Dates** in Excel date format, in the first column (or in the first row) 
- **Titles** of the series in the corresponding cell of the first row (or in the first column)
- **Top-left cell $A1$** can include text or it can be left empty
- **Empty cells** are interpreted by JDemetra+ as missing values
- If empty cells are at the beginning of the series they can be ignored using the option [**clean-missing**](#clean-missing).

![**Example of an Excel spreadsheet that can be imported to JDemetra+**](All_images/excel_spreadcheet.png)

In Excel files, series are identified by their names (colnames) in the file.

:::


#### Text or csv file

The example below show how to import the data from an Excel file.

1.  From the *Providers* window **right-click** on the *Txt files* branch and choose *Open* option.

    ![**Data provider available by default**](All_images/provider-txt-files.png)

2.  The *Open data source* window contains the following options:

    + **Text file** -- a path to access the file.
    
    + **Charset** -- the encoding used to encode the file
    
    + **Lines to skip** -- the number of lines to skip before reading the data
    
    + **Delimiter** -- the character used to separate fields in the file
    
    + **Text qualifier** -- the characters used to retrieve text fileds
    
    + **Has header** -- check tu use the first line as header
    
    + **Data format** (or **Observartion format** in v3) -- the data format used to read dates and values. It includes three fields: *locale* (country), *date pattern* (data format, e.g. *yyyy-mm-dd*), *number pattern* (a metaformat of numeric value, e.g. 0.## represents two digit number).

    + **Frequency** -- time series frequency. This can be undefined, yearly, half-yearly, four-monthly, quarterly, bi-monthly, or monthly. When the frequency is set to undefined, JDemetra+ determines the time series frequency by analysing the sequence of dates in the file.

    + **Aggregation type** -- the type of aggregation (over time for each time series in the dataset) for the imported time series. This can be *None*, *Sum*, *Average*, *First*, *Last*, *Min* or *Max*. The aggregation can be performed only if the *frequency* parameter is specified. For example, when frequency is set to *Quarterly* and aggregation type is set to *Average*, a monthly time series is transformed to quarterly one with values that are equal to the one third of the sum of the monthly values that belong to the corresponding calendar quarter.

    + **Clean missing** -- erases the missing values of the series.
    
    + **Partial aggregation** -- Allow partial aggregation (only with average and sum aggregation).

    Next, in the *Source* section click the grey "..." button to open the file.

    ![**Data source window**](All_images/provider-open-txt-files.png)

3.  Choose a file and click *OK*.

    ![**Choice of an Excel spreadsheet**](All_images/provider-open-file.png)

4.  The data are organized in a tree structure.

    ![**Options for importing data**](All_images/provider-txt-file-structure.png)


::: {.callout-note collapse="true" title="How to set up you text or csv file"}

- **Dates** in Excel date format, in the first column (or in the first row) 
- **Titles** of the series in the corresponding cell of the first row (or in the first column)
- **Top-left cell $A1$** can include text or it can be left empty
- **Empty cells** are interpreted by JDemetra+ as missing values
- If empty cells are at the beginning of the series they can be ignored using the option [**clean-missing**](#clean-missing).

![**Example of an Excel spreadsheet that can be imported to JDemetra+**](All_images/excel_spreadcheet.png)

In text files, series are identified by their position in the file.

:::

:::



::: {.content-visible when-format="pdf"}

#### Spreadsheet

The example below show how to import the data from an Excel file.

1.  From the *Providers* window **right-click** on the *Spreadsheets* branch and choose *Open* option.

    ![**Data provider available by default**](All_images/Aimage6.jpeg)

2.  The *Open data source* window contains the following options:

    + **Spreadsheet file** -- a path to access the Excel file.

    + **Data format** (or **Observartion format** in v3) -- the data format used to read dates and values. It includes three fields: *locale* (country), *date pattern* (data format, e.g. *yyyy-mm-dd*), *number pattern* (a metaformat of numeric value, e.g. 0.## represents two digit number).

    + **Frequency** -- time series frequency. This can be undefined, yearly, half-yearly, four-monthly, quarterly, bi-monthly, or monthly. When the frequency is set to undefined, JDemetra+ determines the time series frequency by analysing the sequence of dates in the file.

    + **Aggregation type** -- the type of aggregation (over time for each time series in the dataset) for the imported time series. This can be *None*, *Sum*, *Average*, *First*, *Last*, *Min* or *Max*. The aggregation can be performed only if the *frequency* parameter is specified. For example, when frequency is set to *Quarterly* and aggregation type is set to *Average*, a monthly time series is transformed to quarterly one with values that are equal to the one third of the sum of the monthly values that belong to the corresponding calendar quarter.

    + **Clean missing** <a id="clean-missing"></a> -- erases the missing values of the series.

    Next, in the *Source* section click the grey "..." button to open the file.

    ![**Data source window**](All_images/Aimage7.jpeg)

3.  Choose a file and click *OK*.

    ![**Choice of an Excel spreadsheet**](All_images/Aimage8.jpeg)

4.  The user may specify *Data format*, *Frequency* and *Aggregation type*, however this step is not compulsory. When these options are specified JDemetra+ is able to convert the time series frequency. Otherwise, the functionality that enables the time series frequency to be converted will not be available.

    ![**Options for importing data**](All_images/Aimage9.jpeg)

5.  The data are organized in a tree structure.

    ![**Dataset structure**](All_images/Aimage10.jpeg)

Once imported, your spreadsheet is visible as a "node" structure

![**A structure of a dataset**](All_images/A_Ref6.jpg)

::: {.callout-caution title="Accepted formats"}

In v2, the formats `.xls` and `.xlsx` are accepted.

In v3, only the format `.xlsx` is accepted. `.xls` files are no longer supported.

:::


::: {.callout-note collapse="true" title="How to set-up your spreadsheet"}

- **Dates** in Excel date format, in the first column (or in the first row) 
- **Titles** of the series in the corresponding cell of the first row (or in the first column)
- **Top-left cell $A1$** can include text or it can be left empty
- **Empty cells** are interpreted by JDemetra+ as missing values
- If empty cells are at the beginning of the series they can be ignored using the option [**clean-missing**](#clean-missing).

![**Example of an Excel spreadsheet that can be imported to JDemetra+**](All_images/excel_spreadcheet.png)

In Excel files, series are identified by their names (colnames) in the file.

:::

#### Text or csv file

The example below show how to import the data from an Excel file.

1.  From the *Providers* window **right-click** on the *Txt files* branch and choose *Open* option.

    ![**Data provider available by default**](All_images/provider-txt-files.png)

2.  The *Open data source* window contains the following options:

    + **Text file** -- a path to access the file.
    
    + **Charset** -- the encoding used to encode the file
    
    + **Lines to skip** -- the number of lines to skip before reading the data
    
    + **Delimiter** -- the character used to separate fields in the file
    
    + **Text qualifier** -- the characters used to retrieve text fileds
    
    + **Has header** -- check tu use the first line as header
    
    + **Data format** (or **Observartion format** in v3) -- the data format used to read dates and values. It includes three fields: *locale* (country), *date pattern* (data format, e.g. *yyyy-mm-dd*), *number pattern* (a metaformat of numeric value, e.g. 0.## represents two digit number).

    + **Frequency** -- time series frequency. This can be undefined, yearly, half-yearly, four-monthly, quarterly, bi-monthly, or monthly. When the frequency is set to undefined, JDemetra+ determines the time series frequency by analysing the sequence of dates in the file.

    + **Aggregation type** -- the type of aggregation (over time for each time series in the dataset) for the imported time series. This can be *None*, *Sum*, *Average*, *First*, *Last*, *Min* or *Max*. The aggregation can be performed only if the *frequency* parameter is specified. For example, when frequency is set to *Quarterly* and aggregation type is set to *Average*, a monthly time series is transformed to quarterly one with values that are equal to the one third of the sum of the monthly values that belong to the corresponding calendar quarter.

    + **Clean missing** -- erases the missing values of the series.
    
    + **Partial aggregation** -- Allow partial aggregation (only with average and sum aggregation).

    Next, in the *Source* section click the grey "..." button to open the file.

    ![**Data source window**](All_images/provider-open-txt-files.png)

3.  Choose a file and click *OK*.

    ![**Choice of an Excel spreadsheet**](All_images/provider-open-file.png)

4.  The data are organized in a tree structure.

    ![**Data structure**](All_images/provider-txt-file-structure.png)


::: {.callout-note collapse="true" title="How to set up you text or csv file"}

- **Dates** in Excel date format, in the first column (or in the first row) 
- **Titles** of the series in the corresponding cell of the first row (or in the first column)
- **Top-left cell $A1$** can include text or it can be left empty
- **Empty cells** are interpreted by JDemetra+ as missing values
- If empty cells are at the beginning of the series they can be ignored using the option [**clean-missing**](#clean-missing).

![**Example of an Excel spreadsheet that can be imported to JDemetra+**](All_images/excel_spreadcheet.png)

In text files, series are identified by their position in the file.

:::

:::


    
### Wrangling data

Series uploaded to the *Providers* window can be 

- [Displayed](#container), 
- Modified
- Tested for seasonality / white noise

or used in any available algorithm (link to list)

- Modelled Modelling
- Seasonnally adjusted 
- Benchmarked



### Behaviour options 

#### Restoring data sources

The data sources can be restored after re-starting the application so that there is no need to get them again. This functionality can be set in the *Behaviour* tab available at the [*Option*](#options-window) item from the [*Tools*](#tools-menu) menu.

#### Add Star

You can also favorite files to find them each time you open the software.

To favorite a file:

- **right-click** on the file
- click on **Add star**

![**Create a new favorite**](All_images/add_star.png)


A favorite file will have a little star on top right of the logo:

![**Example of a favorite file**](All_images/favorite_file.png)


To remove a favorite:

- **right-click** on the file
- click on **Remove star**

![**Remove a favorite**](All_images/remove_star.png)



## Workspace Structure

The workspace is the main data structure used by JDemetra+.

The workspace saved by JDemetra+ includes:

- Main folder containing several folders that correspond to the different types of items created by the user and;

- The `.xml` file that enables the user to import the workspace to the application and to display its content.

![**Example of a workspace created by JDemetra+.**](All_images/A_Ref7.png)

The workspace can be shared with other users, which eases the burden of work with defining specifications, modelling and seasonal adjustment processes.

The main folder contains:

- a folder **SAProcessing** with all the result of the SA
- folders **TramoSeatsSpec** and/or **X13Spec** with the custom specifications
- a folder **Variables** for external regressor and variables
- a folder **Calendars** with the calendars used to correct the trading days effect
- a folder **Output** contains all the generated output from the GUI

![**Structure of a workspace**](All_images/ws_structure.png)




## Workspace window {#workspace-window}

The workspace window displays the **characteristics** of a workspace but ALSO gives access to other peripheric routines, the results of which won't be stored in a workspace (as data structure).

::: {.content-visible when-format="html"}

You can click on the image in the area that interests you:

<img src="All_images/A_Ref8.png" usemap="#image_map2">
<map name="image_map2">
  <area alt="modelling" title="Modeling" href="#modelling-window" coords="0,50,554,206 shape="rect">
  <area alt="sa" title="Seasonal adjustment" href="#sa-window" coords="0,206,554,434" shape="rect">
  <area alt="utilities" title="Utilities" href="A-calendar-correction.html#usr-def-cal" coords="0,434,554,513" shape="rect">
</map>

<script> initializeAndAdjust("image_map2") </script>

::: {.image-map-caption}
**The *Workspace* window**
:::

:::


::: {.content-visible when-format="pdf"}

![**The *Workspace* window**](All_images/A_Ref8.png)

:::

You can find:

- [Modelling](#modelling-window) (contains the default and user-defined specifications for modelling; and the output from the modelling process)

- [Seasonal adjustment](#sa-window) (contains the default and user-defined specifications for seasonal adjustment and the output from the seasonal adjustment process),

- Utilities ([calendars](#usr-def-cal) and [user defined variables](#usr-def-var)).


## Results Panel {#results-panel-overview}


Results Panel of seasonal adjustment will be presented in another chapter 



## Top Bar Menu and options {#topbar-menu}

::: {.content-visible when-format="html"}

You can click on the image in the area that interests you:

<img src="All_images/tool_bar_map.png" usemap="#bar-menu-map">
<map name="bar-menu-map">
    <area target="" alt="file" title="File" href="#file-menus" coords="71,37,31,8" shape="rect">
    <area target="" alt="statistical-methods" title="Statistical methods" href="#statistical-methods" coords="198,38,82,8" shape="rect">
    <area target="" alt="view" title="View" href="#view" coords="207,8,275,40" shape="rect">
    <area target="" alt="tools" title="Tools" href="#tools-menu" coords="282,9,350,38" shape="rect">
    <area target="" alt="window" title="Window" href="#window-menu" coords="356,9,439,39" shape="rect">
    <area target="" alt="help" title="Help" href="#help-menu" coords="445,9,518,40" shape="rect">
</map>

<script> initializeAndAdjust("bar-menu-map") </script>

::: {.image-map-caption}
**The Top bar menus**
:::

:::


::: {.content-visible when-format="pdf"}

![**The Top bar menus**](All_images/top_bar_menu.png)

:::


The majority of functionalities are available from the main application menu, which is situated at the very top of the main window. If the user moves the cursor to an entry in the main menu and clicks on the left mouse button, a drop-down menu will appear. Clicking on an entry in the drop-down menu selects the highlighted item.

![**The main menu with selected drop-down menu**](All_images/A_Ref10.jpg)


The functions available in the main application menu are:

- [File](#file-menus)
- [Statistical methods](#statistical-methods)
- [View](#view)
- [Tools](#tools-menu)
- [Window](#window-menu)
- [Help](#help-menu)
- [RegArimaDoc](#RegArimaDoc)
- [X-13Doc](#X-13Doc)
- [TramoDoc](#TramoDoc)
- [TramoSeatsDoc](#TramoSeatsDoc)
- [SAProcessingDoc](#SAProcessingDoc)

### File {#file-menus}

The *File* menu is intended for working with [workspaces](#workspace-window) and [data sources](#providers-window). It offers the following functions:

- **New Workspace** -- creates a new workspace and displays it in the *Workspace* window with a default name (*Workspace\_#number*);

- **Open Workspace** -- opens a dialog window, which enables the user to select and open an existing workspace;

- **Open Recent Workspace** -- presents a list of workspaces recently created by the user and enables the user to open one of them;

- **Save Workspace** -- saves the project file named by the system under the default name (*Workspace\_#number*) and in a default location. The workspace can be re-opened at a later time;

- **Save Workspace As...** -- saves the current workspace under the name chosen by the user in the chosen location. The workspace can be re-opened at a later time;

- **Open Recent** -- presents a list of datasets recently used and enables the user to open one of them;

- **Exit** -- closes an application.

![**The content of the *File* menu**](All_images/File menu.jpg)

### Statistical Methods {#statistical-methods}

Here just a hint and link to relevant chapters 

The Statistical methods menu includes functionalities for modelling, analysis and the seasonal adjustment of a time series. They are divided into three groups:

- [Anomaly Detection](#anomaly-detection) -- allows for a purely automatic identification of regression effects;

![**The *Anomaly detection* tab.**](All_images/Statistical methods menu anomaly detection.png)

- [Modelling](#modelling) -- enables time series modelling using the TRAMO and RegARIMA models;

![**The *Modelling* tab.**](All_images/Statistical methods menu modelling.png)

- [Seasonal adjustment](#seasonal-adjustment??) -- intended for the seasonal adjustment of a time series with the TRAMO-SEATS and X-13ARIMA-SEATS methods.

By default, the *Seasonal adjustment* tab has 3 sub-tabs:

- *Multiprocessing*, 
- *Single Analysis*, 
- and *Tools*.

![**The *Seasonal adjustment* tab in v2**](All_images/Statistical methods menu.png)

::: {.panel-tabset .content-visible when-format="html"}

#### v2

In v2, the *Tools* sub-tabs contains 2 functionalities:

- *Seasonality Tests*
- *Direct-Indirect Seasonal Adjustment*

![**The *Seasonal adjustment* tab in v2**](All_images/Statistical methods menu_v2.png)

#### v3

In v3, the *Tools* sub-tabs contains 2 functionalities:

- *Seasonality Tests*
- *CanovaHansen*

But no direct-indirect analysis.

![**The *Seasonal adjustment* tab in v3**](All_images/Statistical methods menu_v3.png)

:::

::: {.content-visible when-format="pdf"}

In v2, the *Tools* sub-tabs contains 2 functionalities:

- *Seasonality Tests*
- *Direct-Indirect Seasonal Adjustment*

![**The *Seasonal adjustment* tab in v2**](All_images/Statistical methods menu_v2.png)

In v3, the *Tools* sub-tabs contains 2 functionalities:

- *Seasonality Tests*
- *CanovaHansen*

But no direct-indirect analysis.

![**The *Seasonal adjustment* tab in v3**](All_images/Statistical methods menu_v3.png)

:::



### Tools menu {#tools-menu}

![**The *Tools* menu**](All_images/Tools menu.jpg)

The following functionalities are available from the *Tools* menu:

- [*Container*](#container) -- includes several tools for displaying data in a time domain;
- [*Spectral analysis*](#spectral-analysis-windows) -- contains tools for the analysis of a time series in a frequency domain;
- [*Aggregation*](#aggregation) -- enables the user to investigate a graph of the sum of multiple time series;
- [*Differencing*](#differencing) -- allows for the inspection of the first regular differences of the time series;
- [*Spreadsheet profiler*](#spreadsheet-profiler) -- offers an Excel-type view of the XLS file imported to JDemetra+.
- [*Plugins*](#plugins-overview) -- allows for the installation and activation of plugins, which extend JDemetra+ functionalities.
- [*Options*](#options-window) -- presents the default interface settings and allows for their modification.


#### Container {#container}

*Container* includes basic tools to display the data. The following items are available: *Chart*, *Grid*, *Growth Chart* and *List*.

![**The *Container* menu**](All_images/Container tools.jpg)

detailed in data visualization part (link to set up)



#### Spectral analysis {#spectral-analysis-windows}

The *Spectral analysis* section provides three spectral graphs that allows an in-depth analysis of a time series in the frequency domain. These graphs are the *Auto-regressive Spectrum*, the *Periodogram* and the *Tukey Spectrum*. 

For more information the user may refer to the [spectral analysis chapter](#spectral-analysis) and to the [sprectral graphs section](#t-GUI-tstools-spec-graphs).

![**Tools for spectral analysis**](All_images/A_Ref36.jpg)

#### Aggregation {#aggregation}

*Aggregation* calculates the sum of the selected series and provides basic information about the selected time series, including the start and end date, the number of observations and a sketch of the data graph. 

link to data visu chap 


#### Differencing {#differencing}

The *Differencing* window displays the first regular differences for the selected time series together with the corresponding periodogram and the PACF function. 

link to data visu chap 


#### Spreadsheet profiler {#spreadsheet-profiler}

The *Spreadsheet profiler* offers an Excel-type view of the XLS file imported to JDemetra+. To use this functionality drag the file name from the *Providers* window and drop it to the empty *Spreadsheet profiler* window.

![**The *Spreadsheet Profiler* window**](All_images/A_Ref40.jpg)


#### Plugins {#plugins-overview}

Installation an functionalities of plugins are described in the related [chapter](#plugins).


### View {#view}

The View menu contains functionalities that enable the user to modify how JDemetra+ is viewed. It offers the following items:

- **Split** -- the function is not operational in the current version of the software.

- **Toolbars** -- displays selected toolbars under the main menu. The *File* toolbar contains the *Save all* icon. The *Performance* toolbar includes two icons: one to show the performance of the application, the other to stop the application profiling and taking a snapshot. The *Other* toolbar determines the default behaviour of the program when the user double clicks on the data. It may be useful to plot the data, visualise it on a grid, or to perform any pre-specified action, e.g. execute a seasonal adjustment procedure.

- **Show Only Editor** -- displays only the *Results* panel and hides other windows (e.g. *Workspace* and *Providers*).

- **Full Screen** -- displays the current JDemetra+ view in full screen.

![**The *View* menu**](All_images/View menu.jpg)

### Window menu {#window-menu}

The *Window* menu offers several functions that facilitate the analysis of data and enables the user to adjust the interface view to the user's needs.

![**The *Window* menu**](All_images/A_Ref51.jpg)

- **Preview Time Series** -- opens a window that plots any of the series the user selects from *Providers*.

- **Debug** -- opens a *Preview Time Series* window that enables a fast display of the graphs for time series from a large dataset. To display the graph click on the series in the *Providers* window.

- [**Providers**](#providers-window) -- opens (if closed) and activates the *Providers* window.

- [**Variables**](#usr-def-var) -- opens (if closed) and activates the *Variable* window.

- [**Workspace**](#workspace-window) -- opens (if closed) and activates the *Workspace* window.

- **Output** -- a generic window to display outputs in the form of text; useful with certain plug-ins (e.g. tutorial descriptive statistics).

- **Editor** -- activates the editor panel (and update the main menu consequently).

- **Configure Window** -- enables the user to change the way that the window is displayed (maximise, float, float group, minimise, minimise group). This option is active when some window is displayed in the JD+ interface.

- **Properties** -- opens the *Properties* window and displays the properties of the marked item (e.g. time series, data source).

- **Reset Windows** -- restores the default JDemetra+ view.

- **Close Window** -- closes all windows that are open.

- **Close All Documents** -- closes all documents that are open.

- **Close Other Documents** -- closes all open documents except for the one that is active (which is the last activated one).

- **Document Groups** -- enables the user to create and manage document groups.

- **Documents** -- lists all active documents.

### Help menu {#help-menu}

### All TS&view

### Search option


## Options {#options-window}

<!-- very important to detail this in v2 and v3 -->

The *Options* window includes five main panels: 

- *Demetra*, 
- *General*,
- *Keymap*,
- *Appearance*
- and *Miscellaneous*. 

They are visible in the very top of the *Options* window.

![**Main sections of the *Options* window**](All_images/A_Ref41.jpg)


### Demetra panel {#options-demetra-panel}


::: {.panel-tabset .content-visible when-format="html"}

#### v2

By default, the *Demetra* panel is shown. It is divided into seven tabs: 

- *Behaviour*, 
- *Demetra UI*, 
- *Statistics*, 
- *Data transfer*, 
- *Demetra Paths*, 
- *ProcDocumentItems*, 
- and *Interchange*.

![**Demetra panel in v2**](All_images/demetra_panel_v2.png)

#### v3

By default, the *Demetra* panel is shown. It is divided into three tabs:: 

- *Common UI*, 
- *Behaviour*, 
- and *Demetra Paths*.

![**Demetra panel in v3**](All_images/demetra_panel_v3.png)

:::

::: {.content-visible when-format="pdf"}

By default, in v2, the *Demetra* panel is shown. It is divided into seven tabs: 

- *Behaviour*, 
- *Demetra UI*, 
- *Statistics*, 
- *Data transfer*, 
- *Demetra Paths*, 
- *ProcDocumentItems*, 
- and *Interchange*.

![**Demetra panel in v2**](All_images/demetra_panel_v2.png)

In v3, you will just find three tabs: 

- *Common UI*, 
- *Behaviour*, 
- and *Demetra Paths*.

![**Demetra panel in v3**](All_images/demetra_panel_v3.png)

:::


#### Behaviour tab

![**The content of the *Behavior* tab**](All_images/A_Ref42.jpg)

The tab *Behaviour* defines the default reaction of JDemetra+ to some of the actions performed by the user.

- **Providers** -- an option to show only the data providers that are currently available.

![**The option Providers**](All_images/options_demetra_behaviour_providers.png)


- **Persistence** -- an option to restore the data sources after re-starting the application so that there is no need to fetch them again (**Persist opened DataSources**) and an option to restore all the content of the chart and grid tools (**Persist tools content**).

![**The option Persistence**](All_images/options-demetra-behaviour-persistence.png)


- **Threading** -- defines how resources are allocated to the computation (**Batch Pool Size** controls the number of cores used in parallel computation and **Batch Priority** defines the priority of computation over other processes). Changing these values might improve computation speed but also reduce user interface responsiveness.

![**The option Threading**](All_images/options-demetra-behaviour-threading.png)


- **Time Series** -- determines the default behaviour of the program when the user double clicks on the data. It may be useful to plot the data, visualise it on a grid, or to perform any pre-specified action, e.g. execute a seasonal adjustment procedure.

![**The option Time Series**](All_images/options-demetra-behaviour-timeseries.png)


::: {.callout-note title="Low-level options"}

In v3, the option **Show low-level options** unable the user to access more settings in the specification. 

![**Low level options on ARIMA specification**](All_images/options-show_low_level_v3.png)

:::


#### Demetra UI / CommonUI tab


::: {.panel-tabset .content-visible when-format="html"}

##### v2

In v2, this panel is called **Demetra UI**.

![**The content of the *Demetra UI* tab**](All_images/A_Ref43.jpg)

##### v3

In v3, this panel is called **CommonUI**.

![**CommonUI tab in v3**](All_images/options-demetra-commonUI.png)

:::

::: {.content-visible when-format="pdf"}

In v2, this panel is called **Demetra UI**.

![**The content of the *Demetra UI* tab in v2**](All_images/A_Ref43.jpg)

In v3, this panel is called **CommonUI**.

![**CommonUI tab in v3**](All_images/options-demetra-commonUI.png)

:::


The *Demetra UI* tab enables the setting of:

- A default colour scheme for the graphs (**Color scheme**).

![**The option Charts**](All_images/options-demetra-commonUI-charts.png)


- The data format (uses MS Excel conventions). For example, ###,###.#### implies the numbers in the tables and the y-axis of the graphs will be rounded up to four decimals after the decimal point (**Data format** (or **Observation format** in v3)).

![**The option Data format**](All_images/options-demetra-commonUI-data_format.png)


- The default number of last years of the time series displayed in charts representing growth rates (**Growth rates**).

![**The option Growth rates**](All_images/options-demetra-commonUI-growth-charts.png)


- The control of the view of the window for adding pre-specified outliers. (**Pre-specified Outliers**).

![**The option Pre-specified Outliers**](All_images/options-demetra-commonUI-pre_specified_outliers.png)


- The visibility of the icons in the context menus (**Context Menus**).

![**The option Context Menus**](All_images/options-demetra-commonUI-context_menus.png)



#### Demetra path tab

*Demetra Paths* allows the user to specify the relative location of the folders where the data can be found. In this way, the application can access data from different computers. Otherwise, the user would need to have access to the exact path where the data is located. To add a location, select the data provider, click the "**+**" button and specify the location.

::: {.panel-tabset .content-visible when-format="html"}

##### v2

![**The content of the *Demetra Paths* tab in v2**](All_images/options-demetra-demetra_paths_v2.png)

##### v3

![**The content of the *Demetra Paths* tab in v3**](All_images/options-demetra-demetra_paths_v3.png)

:::

::: {.content-visible when-format="pdf"}

![**The content of the *Demetra Paths* tab in v2**](All_images/options-demetra-demetra_paths_v2.png)
![**The content of the *Demetra Paths* tab in v3**](All_images/options-demetra-demetra_paths_v3.png)

:::



#### Statistics tab {#options-statistics}

::: {.panel-tabset .content-visible when-format="html"}

##### v2

![**Statistics tab in v2**](All_images/options-demetra-statistics_v2.png)

##### v3

![**SA panel**](All_images/options-SA-General_v3.png)

:::

::: {.content-visible when-format="pdf"}

![**The content of the *Demetra Paths* tab in v2**](All_images/options-demetra-demetra_paths_v2.png)
![**The content of the *Demetra Paths* tab in v3**](All_images/options-demetra-demetra_paths_v3.png)

:::

The *Statistics* tab includes options to control:

- The number of years used for spectral analysis and for model stability (**Default Number of Last Years**);

::: {.panel-tabset .content-visible when-format="html"}

##### v2

![**Default Number of Last Years option in v2**](All_images/options-demetra-statistics-nbr_last_years_v2.png)

##### v3

![**Default Number of Last Years option in v3**](All_images/options-SA-General-nbr_last_years_v3.png)

:::

::: {.content-visible when-format="pdf"}

![**Default Number of Last Years option in v2**](All_images/options-demetra-statistics-nbr_last_years_v2.png)
![**Default Number of Last Years option in v3**](All_images/options-SA-General-nbr_last_years_v3.png)

:::


- The default pre-defined specification for seasonal adjustment (**Seasonal Adjustment**);

![**Seasonal Adjustment option**](All_images/options-demetra-statistics-seasonnal-adjustment.png)


- The type of the analysis of revision history (**Revision History**):

    + *FreeParameters* -- the RegARIMA model parameters and regression coefficients of the RegARIMA model will be re-estimated each time the end point of the data is changed. This argument is ignored if no RegARIMA model is fit to the series.

    + *Complete* -- the whole RegARIMA model together with regressors will be re-identified and re-estimated each time the end point of the data is changed. This argument is ignored if no RegARIMA model is fitted to the series.

    + *None* -- the ARIMA parameters and regression coefficients of the RegARIMA model will be fixed throughout the analysis at the values estimated from the entire series (or model span).

![**Revision History option in v2**](All_images/options-demetra-statistics-revision_history.png)


- The settings for the quality measures and tests used in a diagnostic procedure:

    + **Default components** -- a list of series and diagnostics that are displayed in the **SAProcessing** \\(\rightarrow\\) **Output** window. The list of default items can be modified with the respective **Select** button (see figure below)
    
    ![**The *Default components* section on the *Statistics* tab**](All_images/options-demetra-statistics-default_component.png)

    + **Diagnostics** -- a list of diagnostics tests, where the user can modify the default settings (see figure "*The panel for modification of the settings for the tests in the Basic checks section*" below).
    

::: {.panel-tabset .content-visible when-format="html"}

##### v2

![**The *Diagnostics* section in v2**](All_images/options-demetra-statistics-diagnostics_v2.png)

##### v3

In v3, you can find this settings in the SA panel in the tabs TramoSeats and X13:

![**Settings for the quality measures and tests in Tramoseats in v3**](All_images/options-SA-TramoSeats_v3.png)

![**Settings for the quality measures and tests in X13 in v3**](All_images/options-SA-X13_v3.png)

:::

::: {.content-visible when-format="pdf"}

![**The *Diagnostics* section in v2**](All_images/options-demetra-statistics-diagnostics_v2.png)

In v3, you can find this settings in the SA panel in the tabs TramoSeats and X13:

![**Settings for the quality measures and tests in Tramoseats in v3**](All_images/options-SA-TramoSeats_v3.png)

![**Settings for the quality measures and tests in X13 in v3**](All_images/options-SA-X13_v3.png)

:::

An explanation of the list of the series and diagnostics components that are displayed in the *Default components* section can be found [here](../theory/output.html).

To modify the settings for a particular measure, double click on a selected row (select the test's name from the list and click on the working tools button), introduce changes in the pop-up window and click the **OK** button.

To reset the default settings for a given test, select this test from the list and click on the backspace button situated below the working tools button. The description of the parameters for each quality measure and test used in a diagnostic procedure can be found in the [output from modelling](#results-panel) and the [output from seasonal adjustment](#results-panel) nodes.

![**The panel for modification of the settings for the tests in the *Basic checks* section**](All_images/A_Ref45.jpg)

The users can customize the diagnostics and they can specify the default settings for different outputs. Their preferences are saved between different sessions of JDemetra+. This new feature is accessible in the *Statistics* tab of the *Options* panel.

![**The settings of the output files**](All_images/A_Ref46.jpg)



#### Data Transfer tab

::: {.panel-tabset .content-visible when-format="html"}

##### v2

The *Data Transfer* tab contains multiple options that define the behaviour of the drag and drop and copy-paste actions. To change the default settings, double click on the selected item. Once the modifications are introduced, confirm them with the **OK** button.

![**The content of the *Data Transfer* tab in v2**](All_images/A_Ref47.jpg)

##### v3

In v3, there is no equivalent of the Data Transfer tab.

:::

::: {.content-visible when-format="pdf"}

In v2, the *Data Transfer* tab contains multiple options that define the behaviour of the drag and drop and copy-paste actions. To change the default settings, double click on the selected item. Once the modifications are introduced, confirm them with the **OK** button.

![**The content of the *Data Transfer* tab in v2**](All_images/A_Ref47.jpg)


In v3, there is no equivalent of the *Data Transfer* tab.

:::


#### ProcDocumentItems tab

::: {.panel-tabset .content-visible when-format="html"}

##### v2

*ProcDocumentItems* includes a list of all reports available for processed documents like seasonal adjustment.

![**The content of the *ProcDocumentItems* tab in v2**](All_images/options-demetra-ProcDocumentItems_v2.png)

##### v3

In v3, there is no equivalent of the *ProcDocumentItems* tab.

:::

::: {.content-visible when-format="pdf"}

In v2, *ProcDocumentItems* includes a list of all reports available for processed documents like seasonal adjustment.

![**The content of the *ProcDocumentItems* tab in v2**](All_images/options-demetra-ProcDocumentItems_v2.png)


In v3, there is no equivalent of the *ProcDocumentItems* tab.

:::



#### Interchange tab

::: {.panel-tabset .content-visible when-format="html"}

##### v2

The *Interchange* tab lists the protocols that can be used to export/import information like calendars, specifications, etc.. For the time being, the user cannot customize the way the standard exchanges are done. However, such features could be implemented in plug-ins.

![**The content of the *Interchange* tab in v2**](All_images/options-demetra-Interchange_v2.png)

##### v3

In v3, there is no equivalent of the *Interchange* tab.

:::

::: {.content-visible when-format="pdf"}

In v2, the *Interchange* tab lists the protocols that can be used to export/import information like calendars, specifications, etc.. For the time being, the user cannot customize the way the standard exchanges are done. However, such features could be implemented in plug-ins.

![**The content of the *Interchange* tab in v2**](All_images/options-demetra-Interchange_v2.png)


In v3, there is no equivalent of the *Interchange* tab.

:::



### General panel

The next section, *General*, allows for the customisation of the proxy settings. A proxy is an intermediate server that allows an application to access the Internet. It is typically used inside a corporate network where Internet access is restricted. In JDemetra+, the proxy is used to get time series from remote servers like .Stat.

![**The *General* tab**](All_images/A_Ref49.jpg)


### Keymap panel

*Keymap* provides a list of default key shortcuts to access some of the functionalities and it allows the user to edit them and to define additional shortcuts.

::: {.panel-tabset .content-visible when-format="html"}

##### v2

![**The *Keymap* tab in v2**](All_images/options-keymap_v2.png)

##### v3

![**The *Keymap* tab in v3**](All_images/options-keymap_v3.png)

:::

::: {.content-visible when-format="pdf"}


![**The *Keymap* tab in v2**](All_images/options-keymap_v2.png)
![**The *Keymap* tab in v3**](All_images/options-keymap_v3.png)

:::


### SA panel

The SA panel is only available in v3.

![**SA panel**](All_images/options-SA_v3.png)


#### General tab

The General tab correspond to the [Statistics tab](#options-statistics) from the [Demetra panel](#options-demetra-panel) in v2.


#### TramoSeats and X13 tabs

![**Tramoseats tab**](All_images/options-SA-TramoSeats_v3.png)

The TramoSeats and X13 tabs correspond to the settings for the quality measures and tests used in a diagnostic procedure in v2.


### Other panels

The *Appearance* and *Miscellaneous* panels are tabs automatically provided by the Netbeans platform. They are not used by JDemetra+.