samples list

List Samples

samples list

Synopsis

omics workbench samples list
  [--max-results]
  [--page]
  [--page-size]
  [--sort]  
  [--platform]
  [--storage-id]

Description

List all samples that are indexed from platforms.

Examples

List all samples

omics workbench samples list

List max 10 samples from a specific platform and storage account.

omics workbench storage list
  --max-results 10
  --platform my-platform
  --storage-id my-aws-account

List the second page of samples, displaying up to 10 samples per page, sorted by platform name in descending order.

omics workbench storage list
  --page 2
  --page-size 10
  --sort platform:desc

Flags:

--max-results=NUMBER

Limit the maximum number of results printed to the console.

--page=NUMBER

Used to set the offset page number. This allows for jumping into an arbitrary page of results.

--page-size=NUMBER

Used to set the number of results returned per page (default 100). Reducing the page size can help with poor internet connections.

--sort=SORT_STRING

An optional flag to define how results are sorted by allowing the user to specify one or more columns and directions to sort by.

The value should be in the form: column(:direction)

Multiple columns can defined to sort by (if they are supported) simply by separating the sorts with a semicolon.

The Direction can be defined by the values: asc AND desc Examples: --sort platform:desc

--platform=PLATFORM_ID

An optional flag to filter the results by the given platform.

--storage-id=STORAGE_ID

An optional flag to filter the results by the given storage account.