-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathT-graphical-user-interface.qmd
852 lines (442 loc) · 60.3 KB
/
T-graphical-user-interface.qmd
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
# Graphical User Interface {.unnumbered}
## Overview
This chapter provides general information about using the graphical interface (GUI). Specific indications related to a given algorithm (X13-ARIMA, Tramo-seats, Benchmarking...) are displayed in the relevant chapters.
### Available algorithms
The graphical user interface in the 2.x family gives access to:
- Seasonal adjustment [(SA) algorithms](A-sa.qmd)
- 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.qmd).
### 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
JDemetra+ is a stand-alone application packed in a zip package. To run JDemetra+ the Java RE 8 or higher is needed. Java RE can be downloaded from [Oracle website](https://www.oracle.com/technetwork/java/javase/downloads/index.html).
The official release of JDemetra+ is accessible at [a dedicated Github page](https://github.com/jdemetra/jdemetra-app/releases). The site presents all available releases - both official releases (labelled in green as latest releases) and pre-releases (labelled in red) - packed in zip packages. From the *Latest release* section either choose the installer appropriate for your operating system (Windows, Linux, Mac OS, Solaris) or take the portable zip-file. The installation process is straightforward and intuitive. For example, when the zip-file is chosen and downloaded, then under Windows OS the application can be found in the "bin"-folder of the installation/unpacked zip.
## Running JDemetra+ {#running-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).
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/ for Windows;
- \~/.nbdemetra/dev/var/log/ for Linux and Solaris;
- \~/Library/Application Support/.nbdemetra/dev/var/log/ for Mac OS X.
In order to remove a previously installed JDemetra+ version, the user should delete an appropriate JDemetra+ folder.
## Closing JDemetra+ {#closing-jdemetra}
To close the application, select *File → Exit* from the [File menu](#file-menus).
The other way is to click on the close box in the upper right-hand corner of the JDemetra+ window.
If there is any unsaved work, JDemetra+ will display a warning and provide the user with the opportunity to save it. The message box is shown below.
## Interface Starting Window
The default view of the JDemetra+ window, which is displayed after launching the program, is clearly divided into several panels.
<img src="All_images/Jd_mainwindow.png" usemap="#image_map">
<map name="image_map">
<area alt="Provider" title="Provider" href="#providers-window" coords="3,88,69,112" shape="rect">
<area alt="Workspaces" title="Workspaces" href="#workspace-window" coords="88,88,162,112" shape="rect">
</map>
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;
- and 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](#application-menus).
- A central empty zone for presenting the actual analyses further called the [Results](#results-panel) panel.
## Providers window {#providers-window}
The *Providers* window presents the list of the data sources and organises the imported series within each data provider.
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).
The *Providers* window organises data in a tree structure reflecting the manner in which data are presented in the original source.
The picture below presents how JDemetra+ visualises the imported spreadsheet file. If the user expands all the pluses under the spreadsheet all the series within each sheet that has been loaded are visible. Here two time series are visible: *Japan* (under the *Asia* branch) and *United States* (under the *North America* branch) while the *Europe* branch is still folded. The names of the time series have been taken from the column headings of the spreadsheet while the names of the branches come from sheets' names.
Series uploaded to the *Providers* window can be [displayed](#container), modified and tested for seasonality and used in estimation routines (see [Modelling](modelling.html) and [Seasonal adjustment](A-sa.html)). 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.
### Spreadsheets {#spreadsheets}
We will now focus on the Spreadsheets data source, which corresponds to the series prepared in an Excel file. The file should have dates in Excel date format. Dates should be placed in the first column (or in the first row) and titles of the series in the corresponding cell of the first row (or in the first column). The top-left cell $A1$ can include text or it can be left empty. The empty cells are interpreted by JDemetra+ as missing values and they can appear at the beginning, in the middle and at the end of the time series. The example is shown below.
Once the spreadsheet is prepared and saved, it can be imported to JDemetra+ as it is shown by the tutorial below.
Time series are identified by their names. JDemetra+ derives some information (like data periodicity, starting and ending period) directly from the first column (or from the first row, depending on the chosen data orientation (vertical or horizontal)).
### Import data {#import-data}
**An example of importing process for the Excel file :**
::: {.content-visible when-format="html"}
:::
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. 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.
2. The *Open data source* window contains the following options:
- **Spreadsheet file** -- a path to access the Excel file.
- **Data format** -- 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.
Next, in the *Source* section click the grey "..." button to open the file.
3. Choose a file and click *OK*.
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.
5. The data are organized in a tree structure.
Once the data has been successfully imported, it is available to the user for various analyses (e.g. visualization, modelling, seasonal adjustment, etc.)
The data are organized in a tree structure. If you expand all the plus-signs under the spreadsheet you will see all the series within each sheet that has been loaded. Here all time series are visible under the Production in construction branch. The names of time series have been taken from the columns' headings of the spreadsheet while the names of the branches come from sheets' names.
## Workspace window {#workspace-window}
Restructure: present all the nodes
Workspace is a JDemetra+ functionality that stores the work performed by the user in a coherent and structured way. By default, each workspace contains the pre-defined modelling and seasonal adjustment specifications and a basic calendar. A specification is a set of modelling and/or seasonal adjustment parameters. Within the workspace the following items can be saved:
- [User-defined modelling specifications](#usr-def-spec) and [seasonal adjustment specifications](#pre-def-spec);
- Documents that contain [results from time series modelling](../reference-manual/output-modelling.html) and [output from the seasonal adjustment process](../reference-manual/output.html);
- [User-defined calendars](#usr_def_cal);
- [User-defined regression variables](#usr-def-var).
Together with the results from modelling and seasonal adjustment, the original data, paths to the input files and parameters of processes are all saved. These results can then be re-opened, updated, investigated and modified in further JDemetra+ sessions.
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.
An example of the workspace is shown in the figure below.
The workspace can be shared with other users, which eases the burden of work with defining specifications, modelling and seasonal adjustment processes.
The content of the workspace is presented in the *Workspace* window. It is divided into three sections:
- [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)).
### Modelling {#modelling-window}
The algorithms implemented in JDemetra+ enable a modelling of the original time series with the Reg-ARIMA model,
including estimation of the regression effects such as outliers and calendar effects. These procedures can be
used just for modelling and forecasting of the original time series but also as a pre-treatment before performing a seasonal adjustement of the series. Hence, this pre-treatement will allow for a more reliable estimation of the time series components performed by the seasonal adjustment procedures.
This section is divided into two parts:
* [Specifications](../reference-manual/modelling-specifications.html), which presents parameters of the modelling procedure.
* [Output](../reference-manual/output-modelling.html), which details a typical output produced by the modelling procedure.
The specifications and output of the modelling procedure are displayed in the [*Workspace* window](#workspace-window).
### Seasonal adjustment {#sa-window}
The primary aim of the seasonal adjustment process is to remove seasonal fluctuations from the time series. To achieve this goal, seasonal adjustment methods decompose the original time series into components that capture specific movements. These components are: trend-cycle, seasonality and irregularity.
The trend-cycle component includes long-term and medium-term movements in the data. For seasonal adjustment purposes there is no need to divide this component into two parts. JDemetra+ refers to the trend-cycle as trend and consequently this convention is used here.
This section presents the options of the seasonal adjustment processes performed by the methods implemented in JDemetra+ (X-12-ARIMA/X-13ARIMA-SEATS and TRAMO/SEATS) and discusses the output displayed by JDemetra+. As these seasonal adjustment methods use different approach to the decomposition, the output produced for both of them has different structure and content. Therefore, the results for both methods are discussed separately.
However, in contrast to the original programs, in JDemetra+ some quality indicators have been implemented for both methods, allowing for an easier comparison of the results.
This section is divided into two parts:
* [Specifications](#pre-pro-spec), which presents parameters of the seasonal adjustment procedure.
* [Output](#results-panel), which explains a typical output produced by the seasonal adjustment procedure.
The specifications and output for the seasonal adjustment procedure are displayed in the *Workspace* window under the *Seasonal adjustment* item.
## Results panel {#results-panel}
The blank zone in the figure above (on the right of the view) is the location where JDemetra+ displays various windows. More than one window can be displayed at the same time. Windows can overlap with each other with the foremost window being the one in focus or active. The active window has a darkened title bar. [The windows in the results panel can be arranged in many different ways](#window-menu), depending on the user's needs. The example below shows one of the possible views of this panel. The results of the user's analysis are displayed in an accompanying window. The picture below shows two panels -- a window containing seasonal adjustment results (upper panel) and another one containing an autoregressive spectrum (lower panel).
## Widgets
### All TS&view
### Search option
## Top bar menus {#application-menus}
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 functions available in the main application menu are:
- [File](#file-menus)
- [Statistical methods](#statistical-methods)
- [Tools](#tools-menu)
- [View](#view)
- [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.
### Statistical Methods {#statistical-methods}
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;
- [Modelling](#modelling) -- enables time series modelling using the TRAMO and Reg-ARIMA models;
- [Seasonal adjustment](#seasonal-adjustment??) -- intended for the seasonal adjustment of a time series with the TRAMO-SEATS and X-13ARIMA-SEATS methods.
### Tools menu {#tools-menu}
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) -- 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*.
Several containers can be opened at the same time. Each of them may include multiple time series.
*Chart* plots the time series as a graph. This function opens an empty window. To display a given series drag and drop the series from the *Providers* window into the empty window. More than one series can be displayed on one graph. The chart is automatically rescaled after adding a new series.
The series to be viewed can be also dragged from the other windows (e.g. from the [*Variables*](#usr-def-var) window) or directly from the windows that display the results of the estimation procedure.
To adjust the view of the chart and save it to a given location use the local menu, which is displayed after right-clicking on the chart. The explanation of the functions available for the local menu is given below.
To display the time series value at a given date, hover over it with the cursor. Once the time series is selected by clicking on it with the right mouse button, the options dedicated to this series are available.
A list of possible actions includes:
- **Open** -- opens selected time series in a new window that contains *Chart* and *Grid* panels.
- **Open with** -- opens the time series in a separate window according to the user choice (*Chart* *& grid* or *Simple chart*). The *All ts views* option is not currently available.
- **Save** -- saves the marked series in a spreadsheet file or in a text file.
- **Rename** -- enables the user to change the time series name.
- **Freeze** -- disables modifications of the chart.
- **Copy** -- copies the series and allows it to be pasted to another application e.g. into Excel.
- **Paste** -- pastes the time series previously marked.
- **Split into yearly components** -- opens a window that presents the analysed series data split by year. This chart is useful to investigate the differences in time series values caused by the seasonal factors as it gives some information on the existence and size of the deterministic and stochastic seasonality in data.
- **Remove** -- removes a time series from the chart.
- **Select all** -- selects all the time series presented in the graph.
- **Show title** -- option is not currently available.
- **Show legend** -- displays the names of all the time series presented on the graph.
- **Edit format** -- enables the user to change the data format.
- **Color scheme** -- allows the colour scheme used in the graph to be changed.
- **Lines thickness** -- allows the user to choose between thin and thick lines to be used for a graph.
- **Clear** -- removes all the time series from the chart.
- **Show all** -- this option is not currently available.
- **Export image to** -- allows the graph to be sent to the printer and saved in the clipboard or as a file in a jpg format.
- **Configure** -- enables the user to customize the chart and series display.
*Grid* enables the user to display the selected time series as a table. This function opens an empty window. To display a given series drag and drop the series from the *Providers* window into the empty window. More than one series can be displayed in one table.
To display options available for a given time series, left click on any time series' observation.
The options available in *Grid* are:
- **Transpose** -- changes the orientation of the table from horizontal to vertical.
- **Reverse chronology** -- displays the series from the last to the first observation.
- **Single time series** -- removes from the table all time series apart from the selected one.
- **Use color scheme** -- allows the series to be displayed in colour.
- **Show bars** -- presents values in a table as horizontal bars.
- **Show crosshair** -- highlights an active cell.
- **Zoom** -- option for modifying the chart size.
When none of the series is selected, the local menu offers a reduced list of options. The explanation of the other options can be found below in the '*Local menu options for chart*' figure in the [*Container*](#container) section.
The *Growth chart* tab opens an empty window. Once a given series is dropped into it, *Growth chart* presents the year-over-year or period-over-period growth rates for the selected time series. More than one series can be displayed in a table. The growth chart is automatically rescaled after adding a new series.
A left click displays a local menu with the available options. Those that are characteristic for the *Growth chart* are:
- **Kind** -- displays m/m (or q/q) and y/y growth rates for all time series in the chart (previous period and previous year options respectively). By default, the period-over-period growth rates are shown.
- **Edit last year** -- for clarity and readability purposes, only five of the last years of observations are shown by default. This setting can be adjusted in the [*Options*](#options-window) section, if required.
The explanation of other options can be found below in the '*Local menu options for chart*' figure in the [*Container*](#container) section.
The *List* tab provides basic information about the chosen time series, such as; the start and end date, the number of observations and a sketch of the data graph. This function opens an empty window. To display information, drag and drop the series from the [*Providers*](#providers-window) window into the *List* window. A right click displays the local menu with all available options. Apart from the standard options, the local menu for *List* enables marking the series that match the selected frequency (yearly, half-yearly, quarterly, monthly) by using the *Select by frequency* option. An explanation of other options can be found below in the '*Local menu options for chart*' figure in the [*Container*](#container) section.
For a selected series a local menu offers an extended list of options. The explanation of the functions available for the local menu is given below in the '*Local menu options for chart*' figure in the [*Container*](#container) section.
#### 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 study [a basic desription of spectral analysis](#spectral-analysis) and [a detailed presentation of the abovementioned tools](#spectral-graphs).
#### 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, in the same way as in the *List* functionality. *Aggregation* opens an empty window. To sum the selected series, drag and drop them from the *Providers* window into the *Aggregation* window. Right click displays the local menu with the available options. The content of the local menu depends on the panel chosen (the panel on the left that contains the list of the series and the panel on the right that presents the graph of an aggregate). The local menu for the list of series offers the option *Select by frequency*, which marks all the series on the list that are yearly, half-yearly, quarterly or monthly (depending on the user's choice). The explanation of the other options can be found below in the '*Local menu options for chart*' figure in the [*Container*](#container) section. The local menu for the panel on the left offers functionalities that are analogous to the ones that are available for the *List* functionalities, while the options available for the local menu in the panel on the left are the same as the ones available in *Chart* (see [*Container*](#container)).
#### Differencing {#differencing}
The *Differencing* window displays the first regular differences for the selected time series together with the corresponding periodogram and the PACF function. By default, the window presents the results for non-seasonally and seasonally differenced series (( $d = 1,D = 1$)). These settings can be changed through the *Properties* window (*Tools* *→ Properties*). A description of a periodogram and the PACF function can be found [here](#periodogram).
The typical results are shown below. The bottom left graph presents the partial autocorrelation coefficients (vertical bars) and the confidence intervals. The right-click local menu offers several functionalities for a differenced series. An explanation of the available options can be found below in the "*Local menu options for chart*" figure in the [*Container*](#container) section.
For the *Partial autocorrelation* and the *Periodogram* panels the right-button menu offers "a copy series" option that allows data to be exported to another application and a graph to be printed and saved to a clipboard or as a jpg file. Information about the partial autocorrelation function is given [here](../theory/ACF_and_PACF.html). The description of a periodogram is presented in [the Spectral graphs scenario](../case-studies/spectralgraphs.html).
#### 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.
#### Plugins {#plugins}
Installation an functionalities of plugins are described in the related [chapter](T-plug-ins.qmd)
#### Options {#options-window}
The *Options* window includes five main panels: *Demetra*, *General*, *Keymap*, *Appearance* and *Miscellaneous*. They are visible in the very top of the *Options* window.
By default, the *Demetra* tab is shown. It is divided into seven panels: *Behaviour*, *Demetra UI*, *Statistics*, *Data transfer*, *Demetra Paths*, *ProcDocumentItems*, and *Interchange*.
*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.
- **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**).
- **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.
- **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 *Demetra UI* tab enables the setting of:
- A default colour scheme for the graphs (**Color scheme**).
- 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**).
- The default number of last years of the time series displayed in charts representing growth rates (**Growth rates**).
- The control of the view of the window for adding pre-specified outliers. (**Pre-specified Outliers**).
- The visibility of the icons in the context menus (**Context Menus**).
The *Statistics* tab includes options to control:
- The number of years used for spectral analysis and for model stability (**Default Number of Last Years**);
- The default pre-defined specification for seasonal adjustment (**Seasonal Adjustment**);
- The type of the analysis of revision history (**Revision History**):
- *FreeParameters* -- the Reg-ARIMA 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 Reg-ARIMA model is fit to the series.
- *Complete* -- the whole Reg-ARIMA 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 Reg-ARIMA model will be fixed throughout the analysis at the values estimated from the entire series (or model span).
- 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)
- **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).
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 adjustement](#results-panel) nodes.
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 *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.
*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.
*ProcDocumentItems* includes a list of all reports available for processed documents like seasonal adjustment. 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 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.
*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.
The *Appearance* and *Miscellaneous* tabs are tabs automatically provided by the Netbeans platform. They are not used by JDemetra+.
### 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.
### 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.
- **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 documents that are open except for the one that is active (which is the last activated one).
- **Document Groups** -- enables the user to create and manage the document groups.
- **Documents** -- lists all documents that are active.
### Help menu {#help-menu}
### RegArimaDoc {#RegArimaDoc}
*RegArimaDoc* is a main menu item that includes functionalities designated for *RegArima* documents. To create a *RegArima* document select *RegArima* from the *Statistical methods* → *Modelling* → *Single Analysis* menu.
The *RegArimaDoc* item is displayed in the main menu of the application when a newly created or existing *RegArima* document is active.
*RegArimaDoc-#number* is a default name that corresponds to the *RegArima* document's name. The default name can be changed by the user in the [*Workspace*](#workspace-window) window (right click on *RegArimaDoc-#number* under the *regarima* node in the *Workspace* window and select rename from the local menu).
The options for *RegArimaDoc* include:
- **Paste** -- pastes the time series to the *RegArimaDoc* window and performs seasonal adjustment for this time series using settings selected for the current process. The series needs to be previously copied, e.g. from the *Providers* window. Otherwise the message informing that the action cannot be done is displayed.
- **Refresh data** -- updates the input data and executes the seasonal adjustment process. This option is only available for *RegArimaDoc* documents saved during a previous session with JDemetra+. To use this option, first create a *RegArimaDoc* document and drag and drop the time series into it. Then save the workspace and close JDemetra+. Next, update the time series (add/change the observations, but do not change either the location of the file or the file name) and open JDemetra+ once again. Open the previously saved workspace and double click on the respective *RegArima* document in the *Workspace* window. Finally, choose the **Refresh data** option from the *RegArimaDoc* menu. JDemetra+ re-estimates the complete seasonal adjustment model automatically, so the results are updated immediately. The user can modify the specification and validate the newly introduced changes using the [Specifications](modelling-specifications.html) functionality.
- **Lock** -- prevents the series from the *RegArimaDoc* from being changed when the user double clicks on a new series in the *Providers* window. However, with this option the user can still change the settings of the specification.
- **Copy spec. to workspace** -- copy the specification of the active document into the workspace. This allows it to be used for further processing.
### X-13Doc {#X-13Doc}
*X13Doc* is a main menu item that includes functionalities designated to *X13* documents. To create a *X13* document select *X13* from the *Seasonal Adjustment* → *Statistical Methods* → *Single Analysis* menu.
The *X13doc* item is displayed in the main menu of the application when a newly created or existing *X13* document is active.
*X13Doc-#number* is a default name that corresponds to the *X13* document's name. It is updated automatically, once the relevant *X13* document is renamed.
The options for the *X13Doc* include:
- **Paste** -- pastes the time series to the *X13Doc* window and performs seasonal adjustment for this time series using settings selected for the current process. The series needs to be copied previously, e.g. from the *Providers* window. Otherwise a message informing that the action cannot be done is displayed.
- **Refresh data** -- updates the input data and executes the seasonal adjustment process. This option is only available for *X13* documents saved during a previous session with JDemetra+. To use this option, first create the *X13* document and drag and drop the data into it. Then save the workspace and close JDemetra+. Next, update the time series (add/change the observations, but do not change either the location of the file or the file name) and open JDemetra+ once again. Open the previously saved workspace and double click on the respective *X13* document in the *Workspace* window. Finally, choose the **Refresh data** option from the *X13Doc* menu. JDemetra+ re-estimates the complete seasonal adjustment model automatically, so the results are updated immediately. The user can modify the specification and validate the newly introduced changes using the *Specification* functionality (see [modelling specifications](modelling-specifications.html) and [seasonal adjustment specifications](sa-specifications.html)).
- **Lock** -- prevents the series from the *X13Doc* from being changed when the user double clicks on a new one in the *Providers* window. However, with this option the user can still change the settings of the specification.
- **Copy spec. to workspace** -- copy the specification of the active document into the workspace. This allows it to be used for further processing.
### TramoDoc {#TramoDoc}
*TramoDoc* is a main menu item that includes functionalities designated to *Tramo* documents. To create a *Tramo* document select *Tramo* from *the Statistical methods* → *Modelling* → *Single Analysis* menu.
The *TramoDoc* is displayed in the main menu of the application when a newly created or existing *Tramo* document is active.
*TramoDoc*-*#number* is a default name that corresponds to the *Tramo* document's name. It is updated automatically, once the relevant *Tramo* document is renamed.
The options for the *TramoDoc* include:
- **Paste** -- pastes the time series to the *TramoDoc* window and performs seasonal adjustment for this time series using settings selected for the current process. The series needs to be previously copied, e.g. from the *Providers* window. Otherwise the message informing that the action cannot be done is displayed.
- **Refresh data** -- updates the input data and executes the seasonal adjustment process. This option is only available for *Tramo* documents saved during previous session with JDemetra+. To use this option, first create the *Tramo* document and drag and drop the data into it. Then save the workspace and close JDemetra+. Next, update the time series (add/change the observations, but do not change neither the location of the file nor the file name) and open JDemetra+ once again. Open the previously saved workspace and double click on the respective *Tramo* document in the *Workspace* window. Finally, choose the **Refresh data** option from the *TramoDoc* menu. JDemetra+ re-estimates the complete seasonal adjustment model automatically, so the results are updated immediately. The user can modify the specification and validate the newly introduced changes using the *Specification* functionality (see [modelling specifications](modelling-specifications.html)).
- **Lock** -- prevents the series from the *TramoDoc* from being changed when the user double clicks on a new one in the *Providers* window. However, with this option the user can still change the settings of the specification.
- **Copy spec. to workspace** -- copy the specification of the active document into the workspace. This allows it to be used for further processing.
### TramoSeatsDoc {#TramoSeatsDoc}
*TramoSeatsDoc* is a default name for the main menu item that includes functionalities designated to *TramoSeats* documents. To create a *TramoSeats* document select *TramoSeats* from the *Seasonal Adjustment* → *Statistical methods* → *Single Analysis* menu.
The *TramoSeatsDoc* item is displayed in the main menu of the application when a newly created or existing *TramoSeats* document is active.
*TramoSeatsDoc* is a default name that corresponds to the *TramoSeats* document's name. It is updated automatically, once the relevant *TramoSeats* document is renamed.
The options for the *TramoSeatsDoc* include:
- **Paste** -- pastes the time series to the *TramoSeatsDoc* window and performs seasonal adjustment for this time series using settings selected for the current process. The series needs to be previously copied, e.g. from the *Providers* window. Otherwise the message informing that the action cannot be done is displayed.
- **Refresh data** -- updates the input data and executes the seasonal adjustment process. This option is only available for the *TramoSeats* documents saved during a previous session with JDemetra+. To use this option, first create *TramoSeats* document and drag and drop the data into it. Then save the workspace and close JDemetra+. Next, update the time series (add/change the observations, but do not change either the location of the file or the file name) and open JDemetra+ once again. Open the previously saved workspace and double click on the respective *TramoSeats* document in the *Workspace* window. Finally, choose the **Refresh data** option from the *TramoSeatsDoc* menu. JDemetra+ re-estimates the complete seasonal adjustment model automatically, so the results are updated immediately. The user can modify the specification and validate the newly introduced changes using the *Specification* functionality (see [modelling specifications](modelling-specifications.html) and [seasonal adjustment specifications](sa-specifications.html)).
- **Lock** -- prevents the series from the *TramoDoc* from being changed when the user double clicks on a new one in the *Providers* window. However, with this option the user can still change the settings of the specification.
- **Copy spec. to workspace** -- copy the specification of the active document into the workspace. This allows it to be used for further processing.
### SAProcessingDoc {#SAProcessingDoc}
*SAProcessingDoc*-*#number* is a main menu item that includes functionalities designated for multi-documents. This item is displayed in the main menu of the application when [a newly created or existing multi-document](../reference-manual/output.html) is active. Note that some options are inactive when none of the time series in the *SAProcessing* window is marked.
The *SAProcessingDoc*-*#number* menu facilitates the management of the multi-document.
The available options include:
- **Default specification** -- opens the window that contains the list of available specifications (both pre-defined and user-defined).
- **Start** -- runs the seasonal adjustment of the times series included in the document.
- **Refresh** -- refreshes a document with new data using one of the revisions policies. This option is only available for multi-documents saved during a previous session with JDemetra+. The description of refresh policies and step-by-step demonstration of how to use them can be found [here](../case-studies/revision.html).
- **Accept** -- for a marked series the option allows the user to accept the results that JDemetra+ marks as not satisfactory. However, the option changes the entry in the *Quality* column in the *SAProcessing* window into **Accepted**, regardless of the initial value of this field. The **Accept** function can be used to distinguish the series for which the results have been examined by the user from those not checked yet. The option can be also activated from the local menu. To use it, first the series in the *SAProcessing* window need to be marked as it is shown in the picture below.
- **Copy spec. to workspace** -- copy the specification of the active document into the workspace. In that way, it can be used for other processing.
- **Edit** -- allows for modification of the content of multi-document. New time series can be added to the multi-document directly from the external source, e.g. Excel (**Paste**). Before choosing this option the user should copy the time series (data, name of the time series and dates). For the series marked in the multi-document the **Copy** option copies the specification's details. It can be pasted into external application. Similarly, the **Copy series** option copies the time series, which can be then pasted to the another application. Both **Cut** and **Delete** remove the marked time series from the multi-document. **Copy components** is a functionality for coping selected output items in a quick and easy way.
- **Clear selection** -- unmarks the series in the *SAProcessing* window. This option is inactive when none of the time series in the *SAProcessing* window is marked.
- **Specification** -- enables the user to change the specification used for seasonal adjustment of a selected series to the one chosen from the list of the pre-defined and user-defined specifications.
- **Priority** -- indicator that can be used to mark series that require more or less attention. The **Priority** parameter takes values from 0 to 10. JDemetra+ computes it automatically, based on the average of the (logged) series. The user can chose the method of its computation (log-based or level based).
- **Initial Order** -- displays times series on the list in an initial order.
- **Output** -- enables the user to export the results to a given output format (TXT, XLS, ODBC, CSV, CSV matrix), to specify the destination folder and to customise the content of the exported file. The list of available output items is determined by the chosen output format and it can be found [here](../theory/output.html). The **Output** option is discussed in detail [here](../case-studies/output.html).
- **Report** -- generates a summary report from a multi-process that includes summary information on several items, such as; the number of series, specifications used, models' summary, diagnostic summary, etc.. An example of the output is presented below.
- **Edit comments** -- a functionality for monitoring a seasonal adjustment process is implemented. The user can add and modify short notes concerning a given time series. These notes are visible in the *Comments* column in the *Processing* window. The notes are displayed when the user hovers the mouse on the given cell.
To add or edit a comment the user can also click on the series in the *Processing* panel and chose an option *Edit comments* from the local menu.
## Data Visualisation
Everything is in [Tools -\> container](#container)
## Generating Output {#output-window}
add : some explanations + link to cruncher (production chapter)
### Steps
1. Once a seasonal adjustment process for the dataset is performed Go to the TOP menu bar and follow the path: *SAProcessing* → *Output...*
2. In the *Batch output* window the user can specify which output items will be saved and the folder in which JDemetra+ saves the results. It is possible to save the results in the *TXT*, *XLS*, *CSV*, and *CSV matrix* formats. In the first step the user should choose the output format from the list.
3. The user may choose more than one format as the output can be generated in different formats at the same time.
4. To display and modify the settings click on the given output format on the list. The available options depend on the output format.
5. For *Csv* format the following options are available: *folder* (location of the file), *file prefix* (name of the file), *presentation* (controls how the output is divided into separate files) and *series* (series included in the file). These options are presented in the next points of this case study.
6. The user can define the folder in which the selected results and components will be saved (click the *folder* item and choose the final destination).
7. With the option *File Prefix* the user can modify the default name of the output saved in the CSV file.
8. *Layout* controls how the output is divided into separate files. Expand the list to display available options:
- *HTable* -- the output series will be presented in the form of horizontal tables (time series in rows).
- *VTable* -- the output series will be presented in the form of vertical tables (time series in columns).
- *List* -- the output series will be presented in the form of vertical tables (time series in rows). Apart from that, for each time series each file contains in separate columns: the data frequency, the first year and of estimation span, the first period (month or quarter) of observation span and the number of observations. The files do not include dates.
9. The *Content* section presents [a list of series that will be included into a set of output files](../theory/output.html). To modify the initial settings click on the grey button in the *Content* section. The *CVS-series* window presents two panels: the panel on the left includes a list of all valuable output items. The panel on the right presents the selected output items. Mark the series and use the arrows to change the settings. Confirm your choice with the *OK* button.
10. Options available for the *XLS* format are the same as for the *TXT* format with an exception of the *Layout* section. The list of available codes in the *Content* section is given [here](../theory/output.html).
- *BySeries* -- all results for a given time series are placed in one sheet;
- *ByComponent* -- results are grouped by components. Each component type is saved in a separate sheet.
- *OneSheet* -- all results are saved in one sheet.
11. If the user sets the option layout to *ByComponent*, the output will be generated as follows:
12. The option *OneSheet* will produce the following *XLS* file:
13. By default, the series in the Excel output files are organised vertically. When the user unmarks the check box the horizontal orientation is used.
14. In the case of the *TXT* format the only available options are *folder* (location of the file) and *series* (results included in the output file). The list of available codes in the *Content* section is given [here](../theory/output.html).
15. The *CSV matrix* produces the CSV file containing information about the model and quality diagnostics of the seasonal adjustment. The user may generate the list of default items or create their own quality report. By default, all the available items are included in the output. The list of the items is given [here](../theory/output.html).
16. Once the output settings are selected, click the *OK* button.
17. For each output JDemetra+ provides information on the status of the operation. An example is presented below.
