airr (version 1.5.0)

Schema-class: S4 class defining an AIRR standard schema

Description

Schema defines a common data structure for AIRR Data Representation standards.

Usage

# S4 method for Schema
names(x)
# S4 method for Schema,character
[(x, i)
# S4 method for Schema
$(x, name)
InfoSchema
DataFileSchema
AlignmentSchema
RearrangementSchema
RepertoireSchema
GermlineSetSchema
GenotypeSetSchema
AIRRSchema

Format

A Schema object.

An object of class Schema of length 1.

An object of class Schema of length 1.

An object of class Schema of length 1.

An object of class Schema of length 1.

An object of class Schema of length 1.

An object of class Schema of length 1.

An object of class Schema of length 1.

An object of class list of length 26.

Arguments

x

Schema object.

i

field name.

name

field name.

Slots

definition

name of the schema definition.

required

character vector of required fields.

optional

character vector of non-required fields.

properties

list of field definitions.

info

list schema information.

Details

The following predefined Schema objects are defined:

InfoSchema: AIRR Info Schema.

DataFileSchema: AIRR DataFile Schema.

AlignmentSchema: AIRR Alignment Schema.

RearrangementSchema: AIRR Rearrangement Schema.

RepertoireSchema: AIRR Repertoire Schema.

GermlineSetSchema: AIRR GermlineSet Schema.

GenotypeSetSchema: AIRR GenotypeSet Schema.

AIRRSchema: named list containing all non-experimental AIRR Schema objects.

See Also

See load_schema for loading a Schema from the definition set.