cmind.utils.cmind_HTML_report_gen

generate HTML reports

Functions

cmind_HTML_report_gen(report_dir, ...[, ...]) utility function for generating HTML reports
cmind_HTML_reports(report_case, base_dir[, ...]) utility function that generates HTML reports for several particular cases
cmind_combine_HTML_reports(base_dir[, ...]) Find all .html reports within base_dir and combine them into a single report
cmind.utils.cmind_HTML_report_gen.cmind_HTML_report_gen(report_dir, report_fname, report_title, fnames, titles, move_flag=False, im_width='', subject_string=[], ForceUpdate=True)[source]

utility function for generating HTML reports

Parameters:

report_dir : str

directory in which to store the HTML report

report_fname : str

filename for the HTML report

report_title : str

title of the report

fnames : list

filenames to include in the report

titles : list

titles corresponding to each filename

move_flag : bool, optional

if True, move the files in fnames into report dir if False, copy the files in fnames into report dir

im_width : bool, optional

width of images in the HTML report

subject_string : str, optional

subject ID to use in figure labels

move_flag : bool, optional

ForceUpdate : bool,optional

if True, rerun and overwrite any previously existing results

cmind.utils.cmind_HTML_report_gen.cmind_HTML_reports(report_case, base_dir, report_dir=None, ForceUpdate=False, extra_params='')[source]

utility function that generates HTML reports for several particular cases

report_case : {‘t1_crop_extract_biascor_segment’,’t1_normalize’,’alpha’,’t1map’,’baselinecbf’}
select particular preset filenames, titles etc for use in calling cmind_HTML_report_gen
base_dir : str
directory where the image files are located
report_dir : str, optional
directory to store the report in
ForceUpdate : bool,optional
if True, rerun and overwrite any previously existing results
extra_params : str,optional
custom parameters used during report generation
cmind.utils.cmind_HTML_report_gen.cmind_combine_HTML_reports(base_dir, report_name=None, max_depth=None, report_title=None, ForceUpdate=True)[source]

Find all .html reports within base_dir and combine them into a single report