The Analysis Resource

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.

The schema is of type object.

{ "$uri": "/api/v1/analyses/a1b2c3d4e5f67890", "analysis_type": "<string>", "complete": false, "created_at": "2023-11-07T05:31:56Z", "draft": false, "error_msg": "<string>", "job": { "$ref": "/api/v1/jobs/a1b2c3d4e5f67890" }, "job_args": {}, "sample": { "$ref": "/api/v1/samples/a1b2c3d4e5f67890" }, "success": false, "updated_at": "2023-11-07T05:31:56Z" }

Introduction

Workflow Environment

Parameters / Arguments

Assets

Results

Analysis types

Analysis resource properties

Introduction

Workflow Environment

Parameters / Arguments

Assets

Results

​Analysis types

​Analysis resource properties

Analysis types

Analysis resource properties