*Excel Variations
To generate keyword files based on a parameter matrix contained in an Excel workbook.
Refer to Spreadsheet Based Variations for further information on this feature.
The keyword begins with an optional line defining the base directory for the generated files. This is followed by an optional line to define the names and locations of the generated keyword files. Finally there is a line containing information about the Excel file and the data within it.
Optional line defining the base directory for the generated keyword files.
[DIRECTORY=Base Directory]
Block of lines to define the names and locations of generated keyword files, along with the required analysis combinations.
Optional line providing a subdirectory for the generated keyword files, and the file names themselves.
[SUBDIRECTORY=Subdirectory] [, FILENAME=File Name]
Line defining the Excel file name, the sheet name (which defaults to the first sheet), the range where the parameter data is stored, and information about the orientation of the data.
EXCEL=Excel Workbook, [SHEET=Worksheet Name], RANGE=Cell Range, [ORIENTATION=Data Orientation]
Base Directory defaults to the directory of the base keyword file if omitted. Although both Subdirectory and File Name are optional inputs, at least one of these entries should be specified in order to create unique names or locations for the generated keyword files. These entries may contain combinations of standard characters and parameter values (denoted via %Parameter Name%). If omitted, Subdirectory is the same as the base directory (i.e. no subdirectory is created). If omitted, File Name is the same as the base keyword file name. Where there is a conflict between generated names, a counter will be appended to the file name (or directory name) to ensure unique names are used.
Worksheet Name is optional and defaults to the first sheet in the Excel workbook. Data Orientation is optional and defaults to HORIZONTAL, meaning parameter names are arranged horizontally across the first row of the data matrix. If ORIENTATION=VERTICAL, then the first column of the data matrix is assumed to contain parameter names.
Refer to ‘Notes’ below for further details.
Input: |
Description |
Subdirectory: |
A subdirectory for the generated keyword files. This entry may contain combinations of standard characters and parameter values. See Note (a). |
Generated File Name: |
The names of the generated keyword files. This entry may contain combinations of standard characters and parameter values. See Note (a). |
Excel Workbook: |
The name of the Excel workbook containing the parameter matrix. |
Worksheet Name: |
The name of the worksheet in the workbook containing the parameter matrix. This entry is optional and defaults to the first sheet in the workbook. |
Cell Range: |
The range of cells within the worksheet which define the parameter matrix. This must be a valid Excel range specification (e.g. “A1:F22”, “$G$17:$L$40” etc.). |
Data Orientation: |
The orientation of the parameter matrix. The default is HORIZONTAL, meaning parameter names are arranged horizontally across the first row. |
Base Directory: |
The base directory for the generated keyword files. This entry is optional and defaults to the directory of the base keyword file. |
(a)The Subdirectory and File Name entries may contain combinations of standard characters and parameter values (denoted via %Parameter Name%). For example, if you had a base file name entitled “Offset.key”, you might wish to create variations such as “25m Offset.key”, “50m Offset.key” etc., in “Near” and “Far” subfolders. This could be achieved by specifying entries such as “Near\%Offset%m Offset” (Subdirectory), and “%Offset%m Offset” (File Name), assuming an Offset parameter has been defined in the Parameter Definitions table. The quotation marks must be included in these two entries.
(b)If a file name includes spaces (e.g. sample 1.xlsx) then it must be enclosed by inverted commas.