samples attributes clear

Remove all of a sample's custom attributes

Synopsis

omics workbench samples attributes clear SAMPLE_ID
  [--force]
  [--namespace=STRING]

Description

Remove all of a sample's custom attributes, leaving it with {}.

This cannot be undone. The command prompts for confirmation unless --force is passed.

Only custom attributes are removed. The sample's pedigree — its sex, affected status, family and parentage — and its phenotypes are stored separately and are left untouched.

To remove some attributes but keep others, use samples attributes set with a document containing only the ones to keep.

Examples

Clear a sample's attributes, confirming at the prompt:

omics workbench samples attributes clear HG002

Clear without prompting, for use in a script:

omics workbench samples attributes clear HG002 --force

Positional Arguments

SAMPLE_ID

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

Flags

--force, -f

Do not prompt for confirmation.

--namespace=STRING

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