An Alignment is an analysis providing sensitive local alignment of a WGS samples against a specific reference genome sample. It has the same properties as an analyses, but lacks the analysis_type field and also includes a tax_id field indicating what .
At this time, there are no v1 API routes for accessing the alignment statistics (e.g., percent identity, coverage, and depth), but alignments can be viewed on the One Codex platform directly. Here's an example public alignment and a list of all alignments for that sample:
| Property | Description |
|---|---|
| $uri string | The analysis ID encoded as an addressable URI |
| created_at date-time | Timestamp for when the analysis was created on the One Codex platform, encoded as a RFC 3339 timestamp |
| updated_at date-time | Timestamp for when the analysis was most recently updated 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"}. |
| job_args object | The arguments passed into this analysis (can be null) |
| sample string | A reference to the sample underlying the analysis, e.g., {"$ref": "/api/v1/sample/0ee172af60e84f61"} |