The Analysis resource represents a reproducible analysis of an underlying sample using a strictly versioned analysis job.

Analysis types

The One Codex platform supports several types of analyses including metagenomic (or taxonomic) classification, in silico panels, and alignments. Additional analysis types are planned and will be added to the v1 API over time.

All user-viewable analyses are available via the /api/v1/analyses route, while the /api/v1/classifications, /api/v1/panels, and /api/v1/alignments routes provide listings of a subset of the same analyses with the relevant type. These specific resources provide more detailed information and additional routes, but represent the same underlying execution of a job against a sample.

Analysis resource properties

The below table summarizes all of the properties for the Analysis resource, with the JSON schema type of each property listed below in italics.

Property

Description

$uri
string

The analysis ID encoded as an addressable URI

analysis_type
string

The type of analysis performed. Currently supported analysis types on the One Codex platform are: classification, panel, and alignment.

created_at
date-time

Timestamp for when the analysis was created on the One Codex platform, encoded as a RFC 3339 timestamp

complete
boolean

If the analysis is complete. Incomplete or pending analyses will show a icon in the One Codex web application.

success
boolean

true if the analysis was successful.

error_msg
string

An error message if the analysis failed. Should generally be "" or null if the analysis succeeded or is pending.

job
string

A reference to the versioned job underlying the analysis, e.g., {"$ref": "/api/v1/jobs/d512cb556241440f"}.

sample
string

A reference to the sample underlying the analysis, e.g., {"$ref": "/api/v1/sample/0ee172af60e84f61"}