afqbrowser.assemble#

afqbrowser.assemble(source, target=None, metadata=None, streamlines=None, title=None, subtitle=None, link=None, sublink=None)#

Spin up an instance of the AFQ-Browser with data provided as a mat file.

Parameters:
sourcestr

Path to a AFQ-Browser nodes csv-file, mat-file containing the AFQ data structure, or to a TRACULA stats folder.

targetstr, optional.

Path to a file-system location to create this instance of the browser in. Default: pwd.

metadatastr, optional.

Path to an input csv metadata file. This file requires a “subjectID” column to work. If a file is provided, it will overwrite metadata provided through other. Default: read metadata from AFQ struct, or generate a metadata table with just a “subjectID” column (e.g., for TRACULA).

streamlinesstr, optional.

Path to a user-supplied streamline JSON file. The file contains a description of tract trajectories in the 3D space of the anatomy. Within each tract, “coreFiber” is a required key, and subsequent numerical keys are not required.

titlestr, optional.

Custom page title. Default: None.

subtitlestr, optional.

Custom page subtitle. Default: None.

linkstr, optional.

Custom href for page title. Default: None.

sublinkstr, optional.

Custom href for page subtitle. Default: None.