genome_spy.CrossInput

class genome_spy.CrossInput(data=Undefined, transform=Undefined, **kwds)View on GitHub

Bases: GenomeSpySchema

Generated wrapper for CrossInput.

Methods

copy(*[, deep])

Return a copy with optional keyword updates.

data([value, description, format, name, ...])

Return a copy with data updated.

resolve_references()

Return this class schema with referenced properties merged in.

to_dict(*[, validate])

Serialize this schema wrapper to a JSON-compatible dictionary.

to_json(*[, validate])

Serialize this schema wrapper to formatted JSON.

transform(value)

Return a copy with transform updated.

validate(instance)

Validate an instance against this wrapper's schema.

data(value=Undefined, /, *, description=Undefined, format=Undefined, name=Undefined, sequence=Undefined, url=Undefined, values=Undefined)View on GitHub

Return a copy with data updated.

Parameters:
  • description (str) – Schema-defined description property.

  • format (CsvDataFormat | dict[str, Any] | DsvDataFormat | JsonDataFormat | BedDataFormat | BedpeDataFormat | WigDataFormat | VcfDataFormat | OtherDataFormat) – Schema-defined format property.

  • name (str) – Schema-defined name property.

  • sequence (SequenceParams | dict[str, Any]) – Generate a sequence of numbers.

  • url (str | Sequence[str] | ExprRef | dict[str, Any] | UrlList | UrlTemplate) – An URL, a list of URLs, or a URL expansion definition from which to load the data set. A URL template can expand values from an ExprRef and attach the expanded value as a field to loaded rows. Gzip-compressed resources are decompressed transparently when the URL, MIME type, or payload indicates gzip content. Use the format.type property to ensure the loaded data is correctly parsed.

  • values (InlineDataset | dict[str, Any]) – The full data set, included inline. This can be an array of objects or primitive values, an object, or a string. Arrays of primitive values are ingested as objects with a data property. Strings are parsed according to the specified format type.

transform(value)View on GitHub

Return a copy with transform updated.

copy(*, deep=True, **kwds)View on GitHub

Return a copy with optional keyword updates.

classmethod resolve_references()View on GitHub

Return this class schema with referenced properties merged in.

to_dict(*, validate=True)View on GitHub

Serialize this schema wrapper to a JSON-compatible dictionary.

to_json(*, validate=True)View on GitHub

Serialize this schema wrapper to formatted JSON.

classmethod validate(instance)View on GitHub

Validate an instance against this wrapper’s schema.