The Panel is an analysis providing results for a set of marker sequences, which can range from very short sequences (e.g., 30-50 bases) to complete genes. These marker sequences are typically either predictive of function (e.g., antimicrobial resistance, virulence) or useful for typing (e.g., indicative of serotype or strain information). A panel has the same properties as an analyses (less the analysis_type
field), and several additional routes that:
- Provide the sample-level panel results ( Experimental)
Property | Description |
---|---|
$uri string | The analysis/panel 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 |
complete boolean | If the panel is complete. Incomplete or pending analyses will show a icon in the One Codex web application. |
success boolean | true if the panel analysis was successful. |
error_msg string | An error message if the classification failed. Should generally be "" or null if the analysis succeeded or is pending. |
job string | A reference to the versioned job underlying the panel, e.g., {"$ref": "/api/v1/jobs/4470c9beeb314d77"} . |
sample string | A reference to the sample underlying the panel, e.g., {"$ref": "/api/v1/sample/6d5247665454405a"} |