BER feature schemas (two schemas, one documentation site)
Documentation entry point only. It imports two separate schemas, the BER feature model and the source-document schema, plus the attribute module both of them import, so this site can show every class once and every relationship between them. Each schema keeps its own file, identifier and prefix; validate data against ber_feature_model.yaml or source_document.yaml, never against this file.
URI: https://w3id.org/ber-data/feature-schemas
Name: feature-schemas
Two schemas
This site documents two schemas together. They are separate files with separate identifiers; the diagram and tables below mix their classes only for reading. Both import a third, smaller module, attributes.yaml, which defines only Attribute, so Attribute belongs to neither schema alone.
| Schema | File | What it describes | Classes | Enumerations |
|---|---|---|---|---|
| BER unified feature model (draft) | ber_feature_model.yaml |
Draft LinkML model for genome and metagenome sequence features across BER data sources (NMDC, JGI IMG, KBase). | AlignmentTarget, Contig, ContigCollection, Dataset, FeatureLocation, LocationPart, SequenceFeature | ContigCollectionTypeEnum, CoordinateSystemEnum, EndpointStatusEnum, LocationOperatorEnum, MethodEnum, ScoreTypeEnum, StrandEnum, TopologyEnum |
| Feature source documents (draft) | source_document.yaml |
Ordered source records and scoped metadata from individual GFF3, GTF, BED12 or GenBank artifacts. | SourceArtifact, SourceDocument, SourceRecord | MetadataProfileEnum, MetadataScopeEnum, SourceFormatEnum, SourceRecordKindEnum |
| Reusable attributes (draft) | attributes.yaml |
String-valued attributes for metadata, annotations, and source-reported evidence, with an optional CURIE for the key and an optional number for the value. | Attribute | none |
Relationships
erDiagram
AlignmentTarget {
string gap
integer target_end
string target_id
integer target_start
StrandEnum target_strand
}
Attribute {
uriorcurie attribute_cv_id
string key
float numeric_value
string value
}
Contig {
string contig_id
string generated_by
integer length_bp
float lineage_confidence
uriList source_files
stringList taxonomic_lineage
TopologyEnum topology
integer translation_table
}
ContigCollection {
string name
string collection_id
ContigCollectionTypeEnum collection_type
string generated_by
uriList source_files
stringList taxonomic_lineage
}
Dataset {
}
FeatureLocation {
boolean crosses_origin
LocationOperatorEnum location_operator
}
LocationPart {
integer end
EndpointStatusEnum end_status
integer start
EndpointStatusEnum start_status
StrandEnum strand
}
SequenceFeature {
string name
CoordinateSystemEnum coordinate_system
stringList dbxref
integer end
string feature_id
string generated_by
boolean is_representative
boolean is_selected
MethodEnum method
stringList note
stringList ontology_term
integer phase
string product
string product_source
float score
ScoreTypeEnum score_type
string source
uriList source_files
stringList stable_identifiers
integer start
StrandEnum strand
string translated_sequence
string type
}
SourceArtifact {
integer byte_size
string sha256
uri uri
}
SourceDocument {
SourceFormatEnum format
MetadataProfileEnum profile
}
SourceRecord {
stringList feature_columns
SourceRecordKindEnum kind
integer line_number
string metadata_type
string raw_text
string record_id
MetadataScopeEnum scope
string sequence_id
string sequence_text
stringList warnings
}
Contig }o--o{ ContigCollection : "member_of"
Dataset ||--o{ Contig : "contigs"
Dataset ||--o{ ContigCollection : "contig_collections"
Dataset ||--o{ SequenceFeature : "features"
FeatureLocation ||--|{ LocationPart : "parts"
Contig ||--o{ LocationPart : "seqid"
SequenceFeature ||--o| AlignmentTarget : "target"
SequenceFeature ||--o| FeatureLocation : "location"
SequenceFeature ||--o{ Attribute : "attributes"
SequenceFeature }o--o{ SequenceFeature : "parent"
Contig ||--o{ SequenceFeature : "seqid"
SequenceFeature ||--o{ SequenceFeature : "seqid (protein coordinates)"
SourceDocument ||--|| SourceArtifact : "artifact"
SourceDocument ||--|{ SourceRecord : "records"
SourceRecord }o--o| SourceRecord : "context_record"
SourceRecord ||--o{ Attribute : "metadata"
Classes
| Class | Description |
|---|---|
| AlignmentTarget | Where a hit aligns on the thing it matched, such as a Pfam model or a referen... |
| Attribute | One named value attached to a record by a consuming model |
| Contig | A reference sequence, chromosome, scaffold, or contig that features are locat... |
| ContigCollection | A set of contigs that belong together, such as one isolate genome, one metage... |
| Dataset | A document holding every Contig and SequenceFeature harmonized from one or mo... |
| FeatureLocation | Ordered component intervals; authoritative when present, with scalar feature ... |
| LocationPart | One oriented, reference-qualified interval with explicit endpoint status |
| SequenceFeature | An annotated sequence interval; explicit conversion profiles define its sourc... |
| SourceArtifact | Location and content identity of the uncompressed UTF-8 artifact read by the ... |
| SourceDocument | A parsed view of one physical artifact, distinct from a harmonized Dataset |
| SourceRecord | One physical source line with an optional, explicitly scoped interpretation |
Slots
| Slot | Description |
|---|---|
| artifact | The physical source represented by this document |
| attribute_cv_id | A CURIE for what the key means, from an ontology or controlled vocabulary, se... |
| attributes | Additional source annotations, metadata, and evidence, including GFF tags not... |
| byte_size | Size of the original source in bytes, including all line endings |
| collection_id | Identifier of the genome, bin or assembly, from the system that defined it |
| collection_type | What kind of contig collection this is |
| context_record | Prodigal Sequence Data or FASTA header record establishing this sequence cont... |
| contig_collections | Every ContigCollection that this dataset's Contigs name in member_of |
| contig_id | Native NMDC or source-system identifier for the contig or scaffold |
| contigs | Every Contig referenced by this dataset's Features |
| coordinate_system | Which coordinate space start/end are measured in |
| crosses_origin | True only when traversal crosses the origin of a known-length circular refere... |
| dbxref | GFF3 Dbxref values, db:id references to records in other databases, in source... |
| end | 1-based inclusive end, always >= start; when location is present this is only... |
| end_status | Exact upper endpoint or a bound before or after the reported coordinate |
| feature_columns | Lexical source fields; exactly nine for GFF3/GTF or twelve for BED12, enforce... |
| feature_id | Identity unique within this Dataset; supplied by the source or assigned by an... |
| features | Every SequenceFeature in this dataset |
| format | Explicitly selected source format; never guessed from a headerless file |
| gap | The alignment in GFF3 Gap form, a CIGAR-like string of operations and lengths |
| generated_by | The workflow execution (or tool run) that produced this ContigCollection, Con... |
| is_representative | Whether the source names this transcript as its gene's representative isoform... |
| is_selected | Whether the annotation pipeline chose this call as canonical for its locus |
| key | Source-reported attribute name, unnormalized (for example a GFF tag or metada... |
| kind | Lexical role of this record in the source stream |
| length_bp | Contig length in base pairs |
| line_number | One-based physical line number; CRLF counts as one line ending |
| lineage_confidence | Confidence value reported alongside the lineage call |
| location | Explicit location parts; parent links and BED drawing blocks are separate con... |
| location_operator | Whether the parts describe one interval, a joined sequence, or ordered interv... |
| member_of | Contig collections this contig belongs to, for example its isolate genome, or... |
| metadata | Ordered source values interpreted from a recognized metadata form; repeated k... |
| metadata_type | Directive name or recognized producer metadata form |
| method | The annotation method or reference database whose search produced this featur... |
| name | Human-readable name, not an identifier and not unique: for a contig collectio... |
| note | GFF3 Note values, free-text remarks about the feature, in source order |
| numeric_value | value read as a number, set by a profile only for keys it knows are numeric |
| ontology_term | GFF3 Ontology_term values, ontology term CURIEs such as GO:0003677, in source... |
| parent | GFF3 column-9 Parent tag(s) |
| parts | Parts in biological traversal order, including strand orientation |
| phase | GFF3 column 8 |
| product | Human-readable functional product name for a gene, e |
| product_source | What justified the product call, e |
| profile | Explicit producer metadata interpretation applied in addition to the selected... |
| raw_text | Original line including its exact CR, LF, or CRLF ending, if present |
| record_id | Document-local record identity derived from the physical line number |
| records | Every physical line, in original order, including blank lines and unrecognize... |
| scope | Scope justified by the format or producer profile; stream means position only |
| score | GFF3 column 6 |
| score_type | What kind of number score is |
| seqid | The reference sequence that start and end are measured along, such as GFF3 co... |
| sequence_id | Source sequence name, present only when explicit or established by a recogniz... |
| sequence_text | Sequence letters from a FASTA body line, with whitespace removed; raw_text re... |
| sha256 | SHA-256 digest of the original uncompressed source bytes |
| source | GFF3 column 2, the producing tool and version, e |
| source_files | Source artifact URLs supporting this record, including any annotation sidecar... |
| stable_identifiers | Identifiers an authority assigns to this feature and keeps across releases, a... |
| start | 1-based inclusive start; when location is present this is only the minimum re... |
| start_status | Exact lower endpoint or a bound before or after the reported coordinate |
| strand | GFF3 column 7 |
| target | Where this hit aligns on the thing it matched; absent for features that are n... |
| target_end | Last aligned position on the target, one-based and inclusive |
| target_id | What the hit aligned to, as the source names it, such as a Pfam accession or ... |
| target_start | First aligned position on the target, one-based and inclusive |
| target_strand | Strand of the alignment on the target, when the target is a nucleotide sequen... |
| taxonomic_lineage | Ranked lineage path, domain to strain, one string per rank |
| topology | Declared reference topology; circular locations also require length_bp |
| translated_sequence | Amino-acid translation of a CDS feature, from the workflow's protein FASTA ou... |
| translation_table | NCBI genetic code used to translate coding features on this contig, such as 1... |
| type | GFF3 column 3, nominally a Sequence Ontology term or accession |
| uri | Supplied provenance URI or the local file URI; the parser never fetches it |
| value | The source's text for one value, as a string: not typed or normalized, with a... |
| warnings | Interpretation problems; the corresponding source line is still retained |
Enumerations
| Enumeration | Description |
|---|---|
| ContigCollectionTypeEnum | Kind of contig collection, using the values and descriptions of KBase CDM Con... |
| CoordinateSystemEnum | Which coordinate space a SequenceFeature's start/end are measured in |
| EndpointStatusEnum | Relationship of the true endpoint to the reported position |
| LocationOperatorEnum | Relationship between ordered location parts |
| MetadataProfileEnum | Producer-specific metadata interpretation, or generic format behavior |
| MetadataScopeEnum | Extent of applicability established by the format or selected producer profil... |
| MethodEnum | Annotation method or reference database that produced an evidence hit |
| ScoreTypeEnum | Kind of number in a feature's score column |
| SourceFormatEnum | Source syntax selected explicitly by the caller |
| SourceRecordKindEnum | Lexical roles preserved in the ordered document stream |
| StrandEnum | GFF3 column-7 strand values |
| TopologyEnum | Reference topology used by location validation and distance queries |
Types
| Type | Description |
|---|---|
| Boolean | A binary (true or false) value |
| Curie | a compact URI |
| Date | a date (year, month and day) in an idealized calendar |
| DateOrDatetime | Either a date or a datetime |
| Datetime | The combination of a date and time |
| Decimal | A real number with arbitrary precision that conforms to the xsd:decimal speci... |
| Double | A real number that conforms to the xsd:double specification |
| Float | A real number that conforms to the xsd:float specification |
| Integer | An integer |
| Jsonpath | A string encoding a JSON Path |
| Jsonpointer | A string encoding a JSON Pointer |
| Ncname | Prefix part of CURIE |
| Nodeidentifier | A URI, CURIE or BNODE that represents a node in a model |
| Objectidentifier | A URI or CURIE that represents an object in the model |
| Sparqlpath | A string encoding a SPARQL Property Path |
| String | A character string |
| Time | A time object represents a (local) time of day, independent of any particular... |
| Uri | a complete URI |
| Uriorcurie | a URI or a CURIE |
Subsets
| Subset | Description |
|---|---|
Supplementary material
Start here: Repository overview · How the pieces fit · Repository map and tasks · Schema diagram · Schema guide
Evidence and formats: Prior art, reading and scope · Model comparison · Columns and producer conventions · Corpus sources and downloads · Acquisition history · Independent validation
Model contracts: Generic attributes · Joined and circular locations · Source documents and comments · Workflow provenance
Conversion and query examples: Versioned profiles · IMG dialects · Phytozome dialects · Protein coordinates · Real BGC query exercise · Round-trip evidence · Converted BED12 · One biosample · Biosample transformation notes · Multiple Pfams · Query requirements · Parsed source document
NMDC-specific analyses: DataObject catalogue and counts · Source sampling
Repository decisions: Build and publish the docs · Artifact layout