check_study

qx_utilities.general.utilities.check_study(startfolder='.', folders=None)

check_study startfolder="." [folders=$TOOLS/python/qx_utilities/templates/study_folders_default.txt]

Identify and report the study base folder.

Parameters

--startfolder (str, default '.'):

The folder from which to start looking for the study folder.

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

Path to the file which defines the study folder structure.

Notes

The function looks for the path to the study folder in the hierarchy starting from the provided startfolder. If found it checks that all the standard folders are present and creates any missing ones. It returns the path to the study folder. If the study folder can not be identified, it returns None.

--- Written by Grega Repovš, 2018-11-14