atlas_core_add

atlas_core_add(atlas, data, by='region')

Join additional metadata columns to atlas core.

Parameters

Name	Type	Description	Default
atlas	BrainAtlas	Brain atlas object.	required
data	pd.DataFrame	DataFrame with metadata to join.	required
by	str	Column to join by. Default is ‘region’.	'region'

Returns

Name	Type	Description
	BrainAtlas	Modified atlas copy.

Examples

>>> import pandas as pd
>>> from ggsegpy import dk, atlas_core_add
>>> atlas = dk()
>>> meta = pd.DataFrame({"region": ["precentral"], "lobe": ["frontal"]})
>>> enriched = atlas_core_add(atlas, meta, by="region")