manage_study

qx_utilities.general.utilities.manage_study(studyfolder=None, action='create', folders=None, verbose=False)

manage_study studyfolder=None action="create"

Create or check the base study folder structure.

Parameters

--studyfolder (str):

The location of the study folder.

--action (str, default 'create'):

Whether to create a new study folder ('create') or check an existing study folder ('check').

--folders (str, default '$TOOLS/python/qx_utilities/templates/study_folders_default.txt'):

Path to the file which defines the study folder structure.

--verbose (bool, default False):

Whether to print detailed output during processing.

Notes

A helper function called by create_study and check_study that does the actual checking of the study folder and generating missing content.