neuromaps.datasets.describe_annotations

neuromaps.datasets.describe_annotations(annots, format='plaintext')

Return detailed descriptions for annotations as a pandas dataframe.

If format is ‘plaintext’, will print the descriptions to the console.

If format is ‘dataframe’, will return a pandas dataframe containing the descriptions.

If format is ‘latex’, will print the descriptions in a format suitable for inclusion in a LaTeX document.

Parameters:

• annots (tuple or list of tuples) – List of tuples identifying annotations, in the same form as returned by available_annotations().

• format (str, optional) – Format to return annotations. Must be one of ‘plaintext’, ‘dataframe’, or ‘latex’. Default: ‘plaintext’

Returns:

df_annot_info – Dataframe containing detailed descriptions for annotations

Return type:

pandas.DataFrame or None