The Sample Resource
A Sample represents an underlying next-generation sequencing (NGS) data file, either in the form of a de-multiplexed FASTQ or a FASTA file. Often, there will be a single sample for each physical specimen, though in some cases there may be multiple Samples for each individual specimen (e.g., in the case of replicates).
Samples should be in FASTA or FASTQ format, optionally gzipped, and may be up to 20GB in size. Uploading samples requires 2 direct API calls, one to start the upload and a second to actually POST the FASTA or FASTQ files. If you need to upload a compressed file over 20GB in size, please contact us for help at support@onecodex.com.
Samples may be public
, shared
, or private
(no icon or if owner by another user and shared via a private project). The visibility of a sample controls access to a sample resource, any analyses (and corresponding jobs) performed on that sample, as well as the sample’s metadata, project, and tags. As such, sensitive samples should always be “private” and shared across accounts using private projects.
Note: Samples imported via an external service (e.g., BaseSpace) may also be marked as importing
until One Codex’s servers have successfully retrieved the file. These samples are always private to the owner
of the sample.
The table below shows all of the properties for the Sample resource.
The schema is of type object
.