Table of Contents
This chapter is a reference for each DFdiscover and each legacy report. The reference information for each report is the same (except for formatting) as that available from DFexplore's Reports view. In that view, the information is available by selecting the report name and clicking .
The description of each report in this reference is divided into sections.
The official name of the report.
The report name is case sensitive and must be typed exactly as specified. This section also provides the brief purpose of the report.
Lists all of the valid options for the report invocation.
When a report is invoked from the command-line, the study number is
a required option and must appear as the first option.
When the same report is invoked from Reports View in DFexplore, the study number
is inserted automatically so it should not be manually inserted in the options list.
The only situation in which the study number is not required,
occurs when the user requests a usage message for the specified report.
A usage message is produced when running a report from a shell or
DFexplore's Reports View
by specifying -u as the first option following the report
name.
Each option is either optional or required.
Most options are, not surprisingly, optional,
a few are required,
and yet others may require one option from a specific subset.
Each option type is indicated with a particular notation.
Except for some required options, a report option begins with
- and is followed by an option letter.
In some cases this may be enough to select the option; in other cases, the
option letter will be further followed by an option string.
![]() | Option Letter |
|---|---|
|
An option letter may be given different meanings in different reports. There is no requirement that the same option letter infers the same meaning when used across different reports. |
Table 2.1. Notation for report options
| Notation | Meaning |
|---|---|
|
{study} | Required. The report will not function without the specification of this option. The option must be provided at the specified location in the list of options. |
|
[-o] | Optional. The option may be omitted. The report will function, albeit differently, with or without this option. |
|
[-o |
Optional, with an additional option string.
The option may be omitted, however when it is used, the option
letter must be immediately followed by a space and the option
string.
The option string generally ends at the next white-space character,
however some option strings may contain spaces, and may or may not
require that such strings be delimited by ".
|
|
{ [-s] | [-u] } | One of the options from the specified subset is required. |
|
[ [-s #] | [-u #] ] | Several options are possible but only zero or one from the specified subset may be used. |
Describes the report purpose in greater detail.
This section describes exactly how the report works in terms of environment, input requirements, output format, dependencies, etc. It may also include detailed information about the report behavior for commonly used combinations of options.
Lists other reference materials, typically other reports, that are relevant to the report. This is an optional section.