Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.onecodex.com/llms.txt

Use this file to discover all available pages before exploring further.

The Functional Profile is an analysis which provides results for identifying gene families and pathways, profiling gene function and organism-specific contributions to metabolic pathways, and measuring gene abundance. The functional analysis leverages the classification resource to associate functional groups with taxonomic information, providing results that can be used to understand the functional capabilities of a sample and which organisms contribute to those functions. A functional profile has the same properties as an analysis, as well as a route for profile-specific results.
​
$uri
string
Pattern: ^/api/v1/functional_profiles\/[^/]+$
Example:

"/api/v1/functional_profiles/a1b2c3d4e5f67890"

​
complete
boolean
default:false
​
created_at
string<date-time>

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

​
error_msg
string | null
Maximum string length: 255
​
job
object

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
object

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

​
success
boolean
default:false