element <study>
Namespace:
http://labkey.org/study/xml
Type:
anonymous complexType
Content:
complex, 21+any attributes, 15 elements
Defined:
globally in study.xsd, see XML source
Includes:
definitions of 21+any attributes and 15 elements
Used:
never
XML Representation Summary
<study
    allowDataspace
 = 
 xs:boolean : "false"
    alternateIdDigits
 = 
 xs:int
    alternateIdPrefix
 = 
 xs:string
    archiveVersion
 = 
 xs:double
    dateBased
 = 
 xs:boolean
    defaultTimepointDuration
 = 
 xs:int
    description
 = 
 xs:string
    descriptionRendererType
 = 
 xs:string
    endDate
 = 
 xs:date
    failForUndefinedTimepoints
 = 
 xs:boolean
    grant
 = 
 xs:string
    importDelay
 = 
 xs:int
    investigator
 = 
 xs:string
    label
 = 
 xs:string
    securityType
 = 
 ("BASIC_READ" | "BASIC_WRITE" | "ADVANCED_READ" | "ADVANCED_WRITE")
    species
 = 
 xs:string
    startDate
 = 
 xs:date
    subjectColumnName
 = 
 xs:string
    subjectNounPlural
 = 
 xs:string
    subjectNounSingular
 = 
 xs:string
    timepointType
 = 
 ("VISIT" | "DATE" | "CONTINUOUS")
   
    >
   
Content: 
 visits? × qcStates? × cohorts? × participantAliasDataset? × datasets? × specimens? × studyViews? × comments? × protocolDocs? × studyDescription? × assayPlan? × treatmentData? × assaySchedule? × properties? × studySecurity?
</study>
Content model elements (15):
assayPlan (in study),
assaySchedule (in study),
cohorts (in study),
comments (in study),
datasets (in study),
participantAliasDataset (in study),
properties (in study),
protocolDocs (in study),
qcStates (in study),
specimens (in study),
studyDescription (in study),
studySecurity (in study),
studyViews (in study),
treatmentData (in study),
visits (in study)
XML Source (see within schema source)
<xs:element name="study">
<xs:complexType>
<xs:all>
<xs:element minOccurs="0" name="visits">
<xs:complexType>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">
Indicates the "file" (string) that lists the study's visits. The file must follow the visit map XML format.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="qcStates">
<xs:complexType>
<xs:attribute name="showPrivateDataByDefault" type="xs:boolean">
<xs:annotation>
<xs:documentation>
This setting determines whether users see non-public data by default. Users can
always explicitly choose to see data in any QC state.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file that stores qc state configuration information.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="cohorts">
<xs:complexType>
<xs:attribute name="mode" type="cohortMode">
<xs:annotation>
<xs:documentation>
Indicates the mode of assignment.
"SIMPLE": Subjects are assigned to a single cohort throughout the study.
"ADVANCED": Subjects may change cohorts mid-study. Note that advanced cohort
management requires automatic assignment via a study dataset.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="type" type="cohortType">
<xs:annotation>
<xs:documentation xmlns="http://www.w3.org/1999/xhtml">
Indicates the method of cohort assignment used in the study.
Can either be "AUTOMATIC" or "MANUAL". See
<a href="https://www.labkey.org/Documentation/wiki-page.view?name=manageCohorts" target="_top">Manage Cohorts</a>
.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="datasetId" type="xs:int">
<xs:annotation>
<xs:documentation>
If the "AUTOMATIC" method of cohort assignment is used the datasetID indicates
the dataset used to describe cohorts.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="datasetProperty" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the column used to assign cohorts in the dataset indicated by the datasetID
for "AUTOMATIC" cohort assignment.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the XML file that records how cohorts are assigned if the "MANUAL" method of
cohort assignment is used.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="participantAliasDataset">
<xs:complexType>
<xs:attribute name="datasetId" type="xs:int" use="required">
<xs:annotation>
<xs:documentation>
The name of the dataset that contains the participant/alias mapping information.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="sourceProperty" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The name of the column/field in the dataset that contains the "source" value for the alias.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="aliasProperty" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The name of the column/field in the dataset that contains the value of the participant's alias.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="datasets">
<xs:annotation>
<xs:documentation>
Provides information on the files that contain and describe the datasets in the study.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element minOccurs="0" name="schema">
<xs:complexType>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file where the schema can be found. The file can follow either
the new, XML format, or the old, schema.tsv format.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="labelColumn" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the column where labels are found.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="typeNameColumn" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the column where type names are found.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="typeIdColumn" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the column where type IDs are found.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="definition">
<xs:complexType>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file that determines what happens during study reload (e.g.,
whether to replace or delete datasets). Typically named STUDYNAME.dataset,
where STUDYNAME is the shortened label of the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:all>
<xs:attribute name="dir" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the directory that stores the relevant file.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file manifest for datasets.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="specimens">
<xs:annotation>
<xs:documentation>
Provides information on the files that describe the specimens in the study.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="dir" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the directory that contains the specimen data and settings.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file that stores specimen data.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="settings" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file that stores specimen settings information.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="studyViews">
<xs:complexType>
<xs:attribute name="dir" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the folder that stores study specific views.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="settings" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file that stores view settings information.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="comments">
<xs:complexType>
<xs:attribute name="participantCommentDatasetId" type="xs:int">
<xs:annotation>
<xs:documentation>
The ID of the dataset that includes comments about participants.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="participantCommentDatasetProperty" type="xs:string">
<xs:annotation>
<xs:documentation>
The property name that includes the participant comments.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="participantVisitCommentDatasetId" type="xs:int">
<xs:annotation>
<xs:documentation>
The ID of the dataset that includes comments about participant visits.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="participantVisitCommentDatasetProperty" type="xs:string">
<xs:annotation>
<xs:documentation>
The property name that includes the participant visit comments.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="protocolDocs" type="exportDirType"/>
<xs:element minOccurs="0" name="studyDescription">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="0" name="description" nillable="true" type="xs:string">
<xs:annotation>
<xs:documentation>
The descriptive text for this study.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="rendererType" type="xs:string">
<xs:annotation>
<xs:documentation>
The render type of the description (HTML, wiki, or text).
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="assayPlan" type="xs:string">
<xs:annotation>
<xs:documentation>
The description of the assay plan for the study.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="treatmentData" type="exportDirType">
<xs:annotation>
<xs:documentation>
The directory that contains the export data for Treatment data.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="assaySchedule" type="exportDirType">
<xs:annotation>
<xs:documentation>
The directory that contains the export data for Assay schedule information.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="properties" type="exportDirType">
<xs:annotation>
<xs:documentation>
The directory that contains the export data for study properties.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="studySecurity">
<xs:complexType>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">
Indicates the "file" (string) that contains the study security policy. The file must follow the study security policy (studySecurityPolicy.xsd) XML format.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:all>
<xs:attribute default="false" name="allowDataspace" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Allow this study to be imported into a Dataspace project. Warning! This does not support all study configurations.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="importDelay" type="xs:int">
<xs:annotation>
<xs:documentation>
For testing/debugging purposes only. The number of seconds to delay the import after the job has started.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveVersion" type="xs:double">
<xs:annotation>
<xs:documentation>
The version number of the LabKey Server that produced this archive.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="label" type="xs:string">
<xs:annotation>
<xs:documentation>
The label used for naming the study in the UI.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="subjectNounSingular" type="xs:string">
<xs:annotation>
<xs:documentation>
The singular noun used to identify subjects. Examples include "Participant", "Mouse", or "Yeast".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="subjectNounPlural" type="xs:string">
<xs:annotation>
<xs:documentation>
The plural noun used to identify subjects. Examples include "Participants", "Mice", or "Yeasts".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="subjectColumnName" type="xs:string">
<xs:annotation>
<xs:documentation>
The column header for subject IDs. Examples include "ParticipantId", "MouseId", or "YeastId".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dateBased" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Deprecated in favor of 'timepointType' attribute.
Indicates whether this study is date-based (vs. time-based).
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="timepointType" type="timepointType">
<xs:annotation>
<xs:documentation>
The timepoint type of the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="startDate" type="xs:date">
<xs:annotation>
<xs:documentation>
The start date of the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="endDate" type="xs:date">
<xs:annotation>
<xs:documentation>
The end date of the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="defaultTimepointDuration" type="xs:int">
<xs:annotation>
<xs:documentation>
For date-based studies, the default duration for timepoints, in days.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="securityType" type="securityType">
<xs:annotation>
<xs:documentation>
Indicates the type of security used for the study. Must be one of the following four options:
"BASIC_READ", "BASIC_WRITE", "ADVANCED_READ" or "ADVANCED_WRITE".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="description" type="xs:string">
<xs:annotation>
<xs:documentation>
The descriptive text for this study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="descriptionRendererType" type="xs:string">
<xs:annotation>
<xs:documentation>
The render type of the description (HTML, wiki, or text).
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="investigator" type="xs:string">
<xs:annotation>
<xs:documentation>
The investigator for the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="grant" type="xs:string">
<xs:annotation>
<xs:documentation>
The grant associated with the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="species" type="xs:string">
<xs:annotation>
<xs:documentation>
The species of the subjects in the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="alternateIdPrefix" type="xs:string">
<xs:annotation>
<xs:documentation>
The alternate ID prefix for the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="alternateIdDigits" type="xs:int">
<xs:annotation>
<xs:documentation>
The number of digits with which to generate an alternate ID for the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="failForUndefinedTimepoints" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Indicates whether new timepoints can be created automatically when data is imported into the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute processContents="lax"/>
</xs:complexType>
</xs:element>
Attribute Detail
Defined:
within (this) study element
XML Source (see within schema source)
<xs:anyAttribute processContents="lax"/>
allowDataspace
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
Defined:
locally, within (this) study element
Allow this study to be imported into a Dataspace project. Warning! This does not support all study configurations.
XML Source (see within schema source)
<xs:attribute default="false" name="allowDataspace" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Allow this study to be imported into a Dataspace project. Warning! This does not support all study configurations.
</xs:documentation>
</xs:annotation>
</xs:attribute>
alternateIdDigits
Type:
xs:int, predefined
Use:
optional
Defined:
locally, within (this) study element
The number of digits with which to generate an alternate ID for the study.
XML Source (see within schema source)
<xs:attribute name="alternateIdDigits" type="xs:int">
<xs:annotation>
<xs:documentation>
The number of digits with which to generate an alternate ID for the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
alternateIdPrefix
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) study element
The alternate ID prefix for the study.
XML Source (see within schema source)
<xs:attribute name="alternateIdPrefix" type="xs:string">
<xs:annotation>
<xs:documentation>
The alternate ID prefix for the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
archiveVersion
Type:
xs:double, predefined
Use:
optional
Defined:
locally, within (this) study element
The version number of the LabKey Server that produced this archive.
XML Source (see within schema source)
<xs:attribute name="archiveVersion" type="xs:double">
<xs:annotation>
<xs:documentation>
The version number of the LabKey Server that produced this archive.
</xs:documentation>
</xs:annotation>
</xs:attribute>
dateBased
Type:
xs:boolean, predefined
Use:
optional
Defined:
locally, within (this) study element
Deprecated in favor of 'timepointType' attribute. Indicates whether this study is date-based (vs. time-based).
XML Source (see within schema source)
<xs:attribute name="dateBased" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Deprecated in favor of 'timepointType' attribute.
Indicates whether this study is date-based (vs. time-based).
</xs:documentation>
</xs:annotation>
</xs:attribute>
defaultTimepointDuration
Type:
xs:int, predefined
Use:
optional
Defined:
locally, within (this) study element
For date-based studies, the default duration for timepoints, in days.
XML Source (see within schema source)
<xs:attribute name="defaultTimepointDuration" type="xs:int">
<xs:annotation>
<xs:documentation>
For date-based studies, the default duration for timepoints, in days.
</xs:documentation>
</xs:annotation>
</xs:attribute>
description
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) study element
The descriptive text for this study.
XML Source (see within schema source)
<xs:attribute name="description" type="xs:string">
<xs:annotation>
<xs:documentation>
The descriptive text for this study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
descriptionRendererType
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) study element
The render type of the description (HTML, wiki, or text).
XML Source (see within schema source)
<xs:attribute name="descriptionRendererType" type="xs:string">
<xs:annotation>
<xs:documentation>
The render type of the description (HTML, wiki, or text).
</xs:documentation>
</xs:annotation>
</xs:attribute>
endDate
Type:
xs:date, predefined
Use:
optional
Defined:
locally, within (this) study element
The end date of the study.
XML Source (see within schema source)
<xs:attribute name="endDate" type="xs:date">
<xs:annotation>
<xs:documentation>
The end date of the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
failForUndefinedTimepoints
Type:
xs:boolean, predefined
Use:
optional
Defined:
locally, within (this) study element
Indicates whether new timepoints can be created automatically when data is imported into the study.
XML Source (see within schema source)
<xs:attribute name="failForUndefinedTimepoints" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Indicates whether new timepoints can be created automatically when data is imported into the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
grant
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) study element
The grant associated with the study.
XML Source (see within schema source)
<xs:attribute name="grant" type="xs:string">
<xs:annotation>
<xs:documentation>
The grant associated with the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
importDelay
Type:
xs:int, predefined
Use:
optional
Defined:
locally, within (this) study element
For testing/debugging purposes only. The number of seconds to delay the import after the job has started.
XML Source (see within schema source)
<xs:attribute name="importDelay" type="xs:int">
<xs:annotation>
<xs:documentation>
For testing/debugging purposes only. The number of seconds to delay the import after the job has started.
</xs:documentation>
</xs:annotation>
</xs:attribute>
investigator
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) study element
The investigator for the study.
XML Source (see within schema source)
<xs:attribute name="investigator" type="xs:string">
<xs:annotation>
<xs:documentation>
The investigator for the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
label
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) study element
The label used for naming the study in the UI.
XML Source (see within schema source)
<xs:attribute name="label" type="xs:string">
<xs:annotation>
<xs:documentation>
The label used for naming the study in the UI.
</xs:documentation>
</xs:annotation>
</xs:attribute>
securityType
Type:
securityType
Use:
optional
Defined:
locally, within (this) study element
Indicates the type of security used for the study. Must be one of the following four options: "BASIC_READ", "BASIC_WRITE", "ADVANCED_READ" or "ADVANCED_WRITE".
XML Source (see within schema source)
<xs:attribute name="securityType" type="securityType">
<xs:annotation>
<xs:documentation>
Indicates the type of security used for the study. Must be one of the following four options:
"BASIC_READ", "BASIC_WRITE", "ADVANCED_READ" or "ADVANCED_WRITE".
</xs:documentation>
</xs:annotation>
</xs:attribute>
species
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) study element
The species of the subjects in the study.
XML Source (see within schema source)
<xs:attribute name="species" type="xs:string">
<xs:annotation>
<xs:documentation>
The species of the subjects in the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
startDate
Type:
xs:date, predefined
Use:
optional
Defined:
locally, within (this) study element
The start date of the study.
XML Source (see within schema source)
<xs:attribute name="startDate" type="xs:date">
<xs:annotation>
<xs:documentation>
The start date of the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
subjectColumnName
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) study element
The column header for subject IDs. Examples include "ParticipantId", "MouseId", or "YeastId".
XML Source (see within schema source)
<xs:attribute name="subjectColumnName" type="xs:string">
<xs:annotation>
<xs:documentation>
The column header for subject IDs. Examples include "ParticipantId", "MouseId", or "YeastId".
</xs:documentation>
</xs:annotation>
</xs:attribute>
subjectNounPlural
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) study element
The plural noun used to identify subjects. Examples include "Participants", "Mice", or "Yeasts".
XML Source (see within schema source)
<xs:attribute name="subjectNounPlural" type="xs:string">
<xs:annotation>
<xs:documentation>
The plural noun used to identify subjects. Examples include "Participants", "Mice", or "Yeasts".
</xs:documentation>
</xs:annotation>
</xs:attribute>
subjectNounSingular
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) study element
The singular noun used to identify subjects. Examples include "Participant", "Mouse", or "Yeast".
XML Source (see within schema source)
<xs:attribute name="subjectNounSingular" type="xs:string">
<xs:annotation>
<xs:documentation>
The singular noun used to identify subjects. Examples include "Participant", "Mouse", or "Yeast".
</xs:documentation>
</xs:annotation>
</xs:attribute>
timepointType
Type:
timepointType
Use:
optional
Defined:
locally, within (this) study element
The timepoint type of the study.
XML Source (see within schema source)
<xs:attribute name="timepointType" type="timepointType">
<xs:annotation>
<xs:documentation>
The timepoint type of the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
Content Element Detail
assayPlan
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) study element
The description of the assay plan for the study.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="assayPlan" type="xs:string">
<xs:annotation>
<xs:documentation>
The description of the assay plan for the study.
</xs:documentation>
</xs:annotation>
</xs:element>
assaySchedule
Type:
exportDirType, empty content
Defined:
locally, within (this) study element
The directory that contains the export data for Assay schedule information.
XML Source (see within schema source)
<xs:element minOccurs="0" name="assaySchedule" type="exportDirType">
<xs:annotation>
<xs:documentation>
The directory that contains the export data for Assay schedule information.
</xs:documentation>
</xs:annotation>
</xs:element>
cohorts
Type:
anonymous, empty content
Defined:
locally, within (this) study element
XML Source (see within schema source)
<xs:element minOccurs="0" name="cohorts">
<xs:complexType>
<xs:attribute name="mode" type="cohortMode">
<xs:annotation>
<xs:documentation>
Indicates the mode of assignment.
"SIMPLE": Subjects are assigned to a single cohort throughout the study.
"ADVANCED": Subjects may change cohorts mid-study. Note that advanced cohort
management requires automatic assignment via a study dataset.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="type" type="cohortType">
<xs:annotation>
<xs:documentation xmlns="http://www.w3.org/1999/xhtml">
Indicates the method of cohort assignment used in the study.
Can either be "AUTOMATIC" or "MANUAL". See
<a href="https://www.labkey.org/Documentation/wiki-page.view?name=manageCohorts" target="_top">Manage Cohorts</a>
.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="datasetId" type="xs:int">
<xs:annotation>
<xs:documentation>
If the "AUTOMATIC" method of cohort assignment is used the datasetID indicates
the dataset used to describe cohorts.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="datasetProperty" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the column used to assign cohorts in the dataset indicated by the datasetID
for "AUTOMATIC" cohort assignment.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the XML file that records how cohorts are assigned if the "MANUAL" method of
cohort assignment is used.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
comments
Type:
anonymous, empty content
Defined:
locally, within (this) study element
XML Source (see within schema source)
<xs:element minOccurs="0" name="comments">
<xs:complexType>
<xs:attribute name="participantCommentDatasetId" type="xs:int">
<xs:annotation>
<xs:documentation>
The ID of the dataset that includes comments about participants.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="participantCommentDatasetProperty" type="xs:string">
<xs:annotation>
<xs:documentation>
The property name that includes the participant comments.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="participantVisitCommentDatasetId" type="xs:int">
<xs:annotation>
<xs:documentation>
The ID of the dataset that includes comments about participant visits.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="participantVisitCommentDatasetProperty" type="xs:string">
<xs:annotation>
<xs:documentation>
The property name that includes the participant visit comments.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
datasets
Type:
anonymous, complex content
Defined:
locally, within (this) study element
Provides information on the files that contain and describe the datasets in the study.
XML Source (see within schema source)
<xs:element minOccurs="0" name="datasets">
<xs:annotation>
<xs:documentation>
Provides information on the files that contain and describe the datasets in the study.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element minOccurs="0" name="schema">
<xs:complexType>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file where the schema can be found. The file can follow either
the new, XML format, or the old, schema.tsv format.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="labelColumn" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the column where labels are found.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="typeNameColumn" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the column where type names are found.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="typeIdColumn" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the column where type IDs are found.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="definition">
<xs:complexType>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file that determines what happens during study reload (e.g.,
whether to replace or delete datasets). Typically named STUDYNAME.dataset,
where STUDYNAME is the shortened label of the study.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:all>
<xs:attribute name="dir" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the directory that stores the relevant file.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file manifest for datasets.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
participantAliasDataset
Type:
anonymous, empty content
Defined:
locally, within (this) study element
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="participantAliasDataset">
<xs:complexType>
<xs:attribute name="datasetId" type="xs:int" use="required">
<xs:annotation>
<xs:documentation>
The name of the dataset that contains the participant/alias mapping information.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="sourceProperty" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The name of the column/field in the dataset that contains the "source" value for the alias.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="aliasProperty" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The name of the column/field in the dataset that contains the value of the participant's alias.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
properties
Type:
exportDirType, empty content
Defined:
locally, within (this) study element
The directory that contains the export data for study properties.
XML Source (see within schema source)
<xs:element minOccurs="0" name="properties" type="exportDirType">
<xs:annotation>
<xs:documentation>
The directory that contains the export data for study properties.
</xs:documentation>
</xs:annotation>
</xs:element>
protocolDocs
Type:
exportDirType, empty content
Defined:
locally, within (this) study element
XML Source (see within schema source)
<xs:element minOccurs="0" name="protocolDocs" type="exportDirType"/>
qcStates
Type:
anonymous, empty content
Defined:
locally, within (this) study element
XML Source (see within schema source)
<xs:element minOccurs="0" name="qcStates">
<xs:complexType>
<xs:attribute name="showPrivateDataByDefault" type="xs:boolean">
<xs:annotation>
<xs:documentation>
This setting determines whether users see non-public data by default. Users can
always explicitly choose to see data in any QC state.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file that stores qc state configuration information.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
specimens
Type:
anonymous, empty content
Defined:
locally, within (this) study element
Provides information on the files that describe the specimens in the study.
XML Source (see within schema source)
<xs:element minOccurs="0" name="specimens">
<xs:annotation>
<xs:documentation>
Provides information on the files that describe the specimens in the study.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="dir" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the directory that contains the specimen data and settings.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file that stores specimen data.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="settings" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file that stores specimen settings information.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
studyDescription
Type:
anonymous, complex content
Defined:
locally, within (this) study element
XML Source (see within schema source)
<xs:element minOccurs="0" name="studyDescription">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="0" name="description" nillable="true" type="xs:string">
<xs:annotation>
<xs:documentation>
The descriptive text for this study.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="rendererType" type="xs:string">
<xs:annotation>
<xs:documentation>
The render type of the description (HTML, wiki, or text).
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
studySecurity
Type:
anonymous, empty content
Defined:
locally, within (this) study element
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="studySecurity">
<xs:complexType>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">
Indicates the "file" (string) that contains the study security policy. The file must follow the study security policy (studySecurityPolicy.xsd) XML format.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
studyViews
Type:
anonymous, empty content
Defined:
locally, within (this) study element
XML Source (see within schema source)
<xs:element minOccurs="0" name="studyViews">
<xs:complexType>
<xs:attribute name="dir" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the folder that stores study specific views.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="settings" type="xs:string">
<xs:annotation>
<xs:documentation>
Names the file that stores view settings information.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
treatmentData
Type:
exportDirType, empty content
Defined:
locally, within (this) study element
The directory that contains the export data for Treatment data.
XML Source (see within schema source)
<xs:element minOccurs="0" name="treatmentData" type="exportDirType">
<xs:annotation>
<xs:documentation>
The directory that contains the export data for Treatment data.
</xs:documentation>
</xs:annotation>
</xs:element>
visits
Type:
anonymous, empty content
Defined:
locally, within (this) study element
XML Source (see within schema source)
<xs:element minOccurs="0" name="visits">
<xs:complexType>
<xs:attribute name="file" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">
Indicates the "file" (string) that lists the study's visits. The file must follow the visit map XML format.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
This XML schema documentation has been generated with DocFlex/XML RE 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set.
DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.
DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).
A commercial license for "DocFlex/XML XSDDoc" will allow you:
  • To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
  • To use certain features disabled in the free mode (such as the full documenting of substitution groups).
  • To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
  • To document local element components both globally and locally (similar to attributes).
  • To enable/disable reproducing of namespace prefixes.
  • To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
  • To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
  • To use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
  • To use the same template to generate the incredible quality RTF documentation.
  • To document only selected XML schema components specified by name.
  • To remove this very advertisement text
Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!
But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!
Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!
To buy a license, please follow this link: http://www.filigris.com/shop/