abagen.mouse.get_structure_info

abagen.mouse.get_structure_info(id=None, acronym=None, name=None, attributes=None, verbose=False)[source]

Queries Allen API for information about given gene

One of structure_id, structure_acronym, or structure_name must be provided.

Parameters:

  • id (int, optional) – Numerical structure ID

  • acronym (str, optional) – Short-form structure acronym (case sensitive)

  • name (str, optional) – Full structure name (case sensitive)

  • attributes (str or list, optional) – Which attributes / information to obtain for the provided structure. See abagen.mouse.available_structure_info() for list of available attributes to request. If not specified all available attributes will be returned. Default: None

  • verbose (bool, optional) – Whether to print status messages. Default: False

Returns:

info – Where columns are the requested attributes and index is the provided structural identifier type (e.g., ‘id’, ‘acronym’, ‘name’)

Return type:

pandas.DataFrame

Raises:

ValueError – The provided structure is invalid

Examples

Get the full names of structures 22 and 1018:

>>> from abagen import mouse
>>> mouse.get_structure_info(id=[22, 1018],
...                          attributes=['acronym', 'name'])  
     acronym                                  name
id
22      PTLp  Posterior parietal association areas
1018    AUDv                 Ventral auditory area