Skip to content

Win Genhol Version 1.0

Version 1.0, Build 2
Nikki Czaplicki
Component ID: #ti1583962603

1. Introduction

Win Genhol is a Windows interface for the Genhol utility (U.S. Census Bureau, 2015). Genhol creates moving holiday regressors that can be incorporated into regARIMA models in X-13ARIMA-SEATS (U.S. Census Bureau, 2015). Genhol can create regressors for effects before holidays, after holidays or an intermediate effect around the holiday. For more information on the Genhol utility, click here.

This version of the program is Version 1.0, Build 2. The only change from the first release of Genhol Version 1.0 is that the names of the user defined regressors are checked on input to see that they are shorter than 17 characters and that each name is unique.

This program will:

  • Create input files necessary for creating moving holiday regressors with Genhol.
  • Run Genhol.
  • Display Genhol input and output files.

Licensing information for this software can be found here:

Component ID: #ti1948851726
Component ID: #ti416322258

2. Requirements

Win Genhol has been tested on Windows XP, Windows 7, and Windows 8. This program requires the .NET Framework 3.5 installed on the computer, which can be downloaded here.

Component ID: #ti533364451
Component ID: #ti1011429634

3. Getting Started

To install Win Genhol:

  1. Download wingenhol_V1.0_B2.zip to a local drive (e.g. C:\wingenhol_V1.0_B2.zip)
  2. Unzip wingenhol_V1.0_B2.zip to that same directory (i.e. Extract to here).
  3. Open the wingenhol folder. This folder contains all of the necessary files for Win Genhol.
  4. Double click on WinGenhol.exe to launch. This will display the Win Genhol main screen.

Component ID: #ti1711155423

4. Win Genhol Main Screen

Component ID: #ti1315070056

Keyboard Shortcuts:

  • Create Input File - Ctrl + I
  • Refresh Files - Ctrl + R
  • File View Settings - Ctrl + S
  • Exit - Ctrl + E
  • Win Genhol Documentation - Ctrl + D
  • Genhol Website - Ctrl + G

Use the Win Genhol main screen to open and run Genhol input files and open Genhol output files. Genhol input files have a .inp extension and have syntax very similar to X-13ARIMA-SEATS spec files. An example of a Genhol input file is given below

    global{
        outfile = 'newholiday.dat'
        outspec = 'newholiday.reg'
        period = 12
        type = ratio
        first = 1990
    }

    holiday1{
        name = aNewHoliday
        infile = 'holidayDates.txt'
        center=calendar
        begbefore = -8
        endbefore = -1
    }

Use the folder browser on the left side to select the folder where the Genhol input files are stored. To open a Genhol input file, select it in the Genhol Input Files list and press the Edit button. To run Genhol, select an input file in the Genhol Input Files list and either press the Run Genhol button or double click the file name.

There are two types of output files produced by Genhol, regressor files and regression spec files. A regressor file is created for every successful Genhol run. It contains the regression matrix in datevalue format for the user-defined holiday regressors generated by Genhol. This file has a .dat extension. The first two years of a regressor file are given below.

        1990 1 0.0
        1990 2 0.0
        1990 3 -0.3832335329341318
        1990 4 0.3832335329341318
        1990 5 0.0
        1990 6 0.0
        1990 7 0.0
        1990 8 0.0
        1990 9 0.0
        1990 10 0.0
        1990 11 0.0
        1990 12 0.0
        1991 1 0.0
        1991 2 0.0
        1991 3 0.6167664670658682
        1991 4 -0.6167664670658682
        1991 5 0.0
        1991 6 0.0
        1991 7 0.0
        1991 8 0.0
        1991 9 0.0
        1991 10 0.0

The regression spec file is a text file containing the regression spec that uses the user-defined regression varaiables generated by Genhol. This file has a .reg extension and is created only when requested. Below is an example of the contents of a regression spec file.

    regression{
        user=(aNewHoliday)
        file="newholiday.dat"
        format="datevalue"
        # start=1990.1
        usertype=holiday
    }

To open a file of either of these types, select the file name in the list and click on the open button below the list or simply double click on the file name. By default these files will be opened with the text editor included with Win Genhol. You can open these text files with the text editor of your choice by selecting File -> File View Settings from the menu or pressing Ctrl + S to open the File View Settings Box, unchecking the Use default viewer box and specifying the executable of the text editor you would like to use.

File View Settings Window

Component ID: #ti1289664594
Component ID: #ti987270058

5. Creating New Input Files

A Genhol input file contains two types of specs, one global spec and one or more holiday specs. The global spec specifies global options and appears first in the input file. The holiday specs give information about each holiday regressor including the name of the file that contains the dates of the holiday and the length of the holiday window.

To create a new Genhol input file, select File - > Create Input File (Ctrl + I) from the menu. This will open the Global Spec window.

Component ID: #ti363896716

Global Spec Arguments

  • Save spec as: The full path and filename (with extension) of the location you would like to save the input file.
  • Save regressor as: The filename (with extension) where the holiday regression matrix will be stored.
  • Number of holidays: The number of holidays to be created. The default is 1.
  • Period: The period of the holiday regressor. Choose 12 to create a regressor for a monthly time series, 6 for a bimonthly series and 4 for a quarterly series. The default is 12.
  • Type: The type of holiday regressor that will be produced. For "count", the number of days found in a holiday window for a given observation is output. For "ratio", the proportion of the holiday window occuring in a given observation is output. The default is ratio.
  • Save output spec as: The filename (with extension) where the regression spec will be stored.
  • First year: A four-digit year that will be the first year saved in the output file. The default is the first year common to all data files supplied by the infile argument for each holiday spec. This argument is optional.
  • Last year: A four-digit year that will be the last year saved in the output file. The default is the last year common to all data files supplied by the infile argument for each holiday spec. This argument is optional
  • First mean year: A four-digit year that denotes the first year used in the calculation of the means of the holiday regressors. This argument is optional.
  • Last mean year: A four-digit year that denotes the last year used in the calculation of the means of the holiday regressors. This argument is optional.
  • Stock day: The stock day for an inventory series, that is, the day of the month when inventory is taken. This option should only be set when creating holiday regressors for stock series.

After selecting the global spec options, press the Next button to move to the Holiday Spec window. The Holiday Spec window has a tab for each holiday to be created as specified in the global spec.

Component ID: #ti326742023

Holiday Spec Arguments

  • Holiday dates file: The full path and filename (with extension) of a text file containing the holiday dates. The holiday dates must be stored in month day year format. See the Win Genhol Examples for an example.
  • Holiday name: The name of the holiday. The holiday name cannot contain spaces, and must be less than 17 characters long. The names entered for each holiday must be unique.
  • Center: Specifies the removal of the sample mean or the seasonal means from the user-defined regression variables. For center = mean, the overall mean(sample mean)of the user-defined regressor is subtracted from the regressor. For center = calendar, the mean of each calendar month, bimonth or quarter (depending on the period selected) is subtracted from the user-defined regressor. When center=none, the regressor is not modified.
  • Zero before: A four-digit year before which the user-defined regressor equals zero.
  • Zero after: A four-digit year after which the user-defined regressor equals zero.
  • Holiday effect details: Use the drop down boxes in this section to choose when the holiday effect occurs. Use the check boxes to activate the drop down boxes for the three possible holiday effect windows, before, during, or after the holiday. You can select more than one holiday effect window for each holiday. All of the holiday windows are inclusive.

Press the Back button to return to the Global Spec window. Press the Create spec button to create the Genhol input file with the selected parameters. This will display the newly created Genhol input file and return to the Win Genhol main screen.

Component ID: #ti61906047
Component ID: #ti44613305

6. Contact Information

Demetra Lytras
U.S. Census Bureau
email: demetra.p.lytras@census.gov

Phone: (301) 763-7426

Component ID: #ti320749019
Component ID: #ti972021957

7. References

U.S. Census Bureau (2015). Genhol Documentation.
U.S. Census Bureau (2015). X-13ARIMA-SEATS Reference Manual.

Component ID: #ti838137944
X
  Is this page helpful?
Thumbs Up Image Yes    Thumbs Down Image No
X
No, thanks
255 characters remaining
X
Thank you for your feedback.
Comments or suggestions?