lyman.frontend.subjects

lyman.frontend.subjects(subject_arg=None, sessions=None, lyman_dir=None)

Find a list of subjects in a variety of ways.

Parameters

subject_arglist or string

This argument can take several forms:

• None, in which case all subject ids in scans.yaml are used.

• A list of subject ids or single subject id which will be used.

• The name (without extension) of a text file in the <lyman_dir> containing list of subject ids, or a list with a single entry corresponding to the name of a file.

• A single subject id, which will be used.

sessionslist

A list of session ids. Only valid when there is a single subject in the returned list. This parameter can be used to validate that the requested sessions exist for the requested subject.

lyman_dirstring

Path to the directory where files with information are stored; otherwise read from the $LYMAN_DIR environment variable.

Returns

subjectslist of strings

A list of subject ids.