The <field> Tag

The <field> tag creates a single input field.  There can be one or more fields per configuration.

Parameters

Name Description Legal Values Default

name

This is the name that is displayed in the Phenote interface next to the input box in the Data Entry section.  This is also used as a column header in the Annotation Spreadsheet.

any text value
syntax-abbrev This is a short abbreviation used by the Pheno-syntax data adapter any text value
desc A short description or definition of what a field is for; could be used to describe contents, proper usage, etc. Pops up as a tooltip if you hover the mouse over the field name in the Annotaiton Editor. any text value
tab The name of the tab to assign this field to in the Annotation Editor (the Data Entry section). If no tab name is assigned, the fields are assigned to numbered tabs with a default of 8 fields per tab. any text value
enable A flag that turns this field on or off.
  • true
  • false
true

Contents

Each <field> element specifies one input area in the Data Entry section. 

There are two types of fields:  free-text or ontology.  By default, a field is of the free-text type.  To specify ontology type, see The <ontology> Tag page.

The order in which the fields are specified in the configuration file will dictate the order in which they display in the Data Entry section, as well as the order of the columns in the Annotation Spreadsheet

Example

Free Text Field

<ns:field name="Field Name" syntax-abbrev="FA" enable="true"/>

Ontology-Controlled Field

  <ns:field name="Quality" datatag="Q" enable="true" warnIfNull="true"
    desc="The quality or relationship of the phenotype"
    tab="More details">
    <ns:ontology name="Relationship" file="http://purl.org/obo/obo/PATO.obo" is-postcomp-rel="true"/>
    <ns:ontology name="PATO" file="http://purl.org/obo/obo/PATO.obo"/>
  </ns:field>