R: S4 class defining an AIRR standard schema

Schema-class {airr}

R Documentation

S4 class defining an AIRR standard schema

Description

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

Usage

## S4 method for signature 'Schema'
names(x)

## S4 method for signature 'Schema,character'
x[i]

## S4 method for signature 'Schema'
x$name

InfoSchema

DataFileSchema

AlignmentSchema

RearrangementSchema

RepertoireSchema

GermlineSetSchema

GenotypeSetSchema

AIRRSchema

Arguments

`x`	`Schema` object.
`i`	field name.
`name`	field name.

Format

A Schema object.

An object of class Schema of length 1.

An object of class list of length 26.

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.

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.