info

How to use the squirrel info tool

Basic queries

To view all subjects in the package, with all subject information, and in csv format

squirrel info <package> --object subject --dataset full --format csv

To view only a list of subject IDs in the package

squirrel info <package> --object subject

Main Options

--dataset

--dataset <dataset> can have one of the following values

Dataset	Description
id	Only a list of identifiers or object names will be listed.
basic	Only basic columns associated. Parent object IDs will also be listed. For example if series is listed, then study and subject IDs will be listed.
full	All columns associated with the object will be listed. Parent object IDs will also be listed. For example if series is listed, then study and subject IDs will be listed.

--format

--format <format> can have one of the following values

Format	Description
list	List the data in tab separated format
csv	List the data is comma separated (csv) format. All string fields will be quoted. This can be piped into a file using the > operator

--object

--object <object> can have one of the following values, which mirrors the squirrel object types

• package (default if object is not specified)

• subject

• study

• series

• experiment

• observation

• intervention

• experiment

• pipeline

• groupanalysis

• datadictionary