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

AlignmentSchema

RearrangementSchema

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 Schema of length 1.

Details

The following predefined Schema objects are defined:

AlignmentSchema: AIRR Alignment Schema.

RearrangementSchema: AIRR Rearrangement Schema.

Slots

required

character vector of required fields.

optional

character vector of non-required fields.

properties

list of field definitions.

info

list schema information.

See Also

See load_schema for loading a Schema from the definition set. See read_airr, write_airr and validate_airr schema operators.


[Package airr version 1.3.0 Index]