samples attributes get

Print a sample's custom attributes

Synopsis

omics workbench samples attributes get SAMPLE_ID
  [--namespace=STRING]

Description

Print a sample's custom attributes exactly as stored, or {} when the sample has none.

Custom attributes are free-form JSON attached to a sample — lab-supplied data the sample schema does not model, such as a barcode map or a kit lot number. They are separate from the sample's pedigree and phenotypes, and are not included in samples describe.

The document is printed unchanged rather than reformatted, so nulls, nested objects and numeric types survive and the output can be piped straight into other tools.

Examples

Print a sample's attributes:

omics workbench samples attributes get HG002

{"kit_lot": "A7-2291", "passed_qc": true, "operator": null}

Read a single value with jq:

omics workbench samples attributes get HG002 | jq -r '.kit_lot'

Save the attributes, edit them, and write them back:

omics workbench samples attributes get HG002 > bag.json
omics workbench samples attributes set HG002 @bag.json

Positional Arguments

SAMPLE_ID

The ID of the sample. Sample IDs can be retrieved from the samples list command.

Flags

--namespace=STRING

An optional flag to define the namespace to connect to. By default, the namespace is extracted from the user's credentials.