DF_SSschema

DF_SSschema — Display detailed data dictionary information

Synopsis

DF_SSschema {study} [-f] [-p # #-#] [-e] [-s] [-v string] [-V string] [-D string] [-T string] [-M string] [-m string]

Description

DF_SSschema displays a detailed description of variables selected from the study data dictionary. The detail for each variable includes:

Plate  Field(*|+|-)(1)(#)(2) Name         Description(3)       <Alias Name>(4)
                               Module[Module Instance] FieldName
                               Type  Style  Length  Format  Legal Values(5)
                               Pivot  Imputation (6)
                               Coding            (7)
                               Skip              (8)
                               Edit checks       (9)

(1)

If the field is:

  • essential, a * is displayed after the field number,

  • required, a + is displayed after the field number,

  • otherwise, a - is displayed, or nothing.

(2)

If a minimum reason level is defined, the reason level is displayed.

(3)

If the description is longer than 25 characters (the length printed on Query Reports), the description is followed by the length and a ?.

(4)

If the variable's alias name is different from the name, the alias name is displayed at the end of the line enclosed in < and >.

(5)

If format and legal values are both undefined then field length is printed, otherwise the format and/or legal values are printed. Note that if legal range definition for the subject ID field includes the meta-word $(ids), the literal $(ids) will be reported as the legal value rather than the (lengthy) concatenated list of subject IDs from all sites.

(6)

The pivot year and imputation method are displayed only if the variable type is date. The pivot year appears only for dates which are defined with a 2 digit year. The default pivot year (if none is specified) is 1940. The date imputation method must be one of: none, start of month and/or year, middle of month and/or year, or, end of month and/or year.

(7)

Coding information appears only for those variables that define coding information.

(8)

Skip information appears only for those variables that define it.

(9)

Edit checks appear if they are defined for the variable. The edit check name appears together with the invocation method which is one of plate enter, field enter, field exit, or plate exit.

The options -v, -V, -D, and -T each accept only one string. If any string includes spaces, it must be enclosed in ". String matching is case sensitive.

When selection options are used in combination, selected variables can match on any of the selection criteria.

The order of plates in the output is the same as the order that plates appear in the schema and in DFsetup. The description of each plate includes information from the Plate > Edit dialog in DFsetup, and includes the plate number, label, and whether or not there is a Preprocess or Postprocess procedure.

Options

-f

Start the output with a description of all study plates

-p # #-#

Select variables only from the specified plates

-e

Select variables that have edit checks defined

-s

Select variables that have skip patterns defined

-v string

Select variables with string in the variable name

-V string

Select variables with string in the alias variable name

-D string

Select variables with string in the variable description

-T string

Select variables with string in the variable type or style

-m string

Select variables with string anywhere in the variable definition. If more than one string is specified, select cases if ANY of the strings are matched.

-M string

Select variables with string anywhere in the variable definition. If more than one string is specified, select cases if ALL of the strings are matched.

Examples

Example 2.96. Display data dictionary information for all variables on plates 7, 8 to 10 inclusive, and 22

-p 7 8~10 22

Example 2.97. Display the description of all study plates, plus all fields on plates 1, 2 and 3

-f -p 1~3

Example 2.98. Display data dictionary information for all variable(s) with DRUG in the variable name

-v DRUG

Example 2.99. Select and display all variable(s) with sore throat in the variable description

-D 'sore throat'

Example 2.100. List variables defined using the Visit Date attribute

-T VisitDate

Example 2.101. Display data dictionary information for all variables with edit checks on plates 1, 2 and 3.

-p 1~3 -e