Dandi Tools#

Configuration File: dandi_tools.json Tool Type: Local Tools Count: 3

This page contains all tools defined in the dandi_tools.json configuration file.

Available Tools#

DANDI_get_dataset (Type: DANDITool)#

Retrieve full metadata for one DANDI dandiset: description, species, data standard, license, and …

DANDI_get_dataset tool specification

Tool Information:

  • Name: DANDI_get_dataset

  • Type: DANDITool

  • Description: Retrieve full metadata for one DANDI dandiset: description, species, data standard, license, and subject/file counts. Example: dandiset_id=’000020’ returns ‘Patch-seq recordings from mouse visual cortex’, House mouse, 1040 subjects, NWB standard. Use DANDI_search_datasets to find a dandiset_id.

Parameters:

  • dandiset_id (string) (required) DANDI dataset identifier, e.g. ‘000020’.

Example Usage:

query = {
    "name": "DANDI_get_dataset",
    "arguments": {
        "dandiset_id": "example_value"
    }
}
result = tu.run(query)

DANDI_list_assets (Type: DANDITool)#

List the data files (assets) in one DANDI dandiset: file path, size, and asset id. Example: dandi…

DANDI_list_assets tool specification

Tool Information:

  • Name: DANDI_list_assets

  • Type: DANDITool

  • Description: List the data files (assets) in one DANDI dandiset: file path, size, and asset id. Example: dandiset_id=’000020’ returns NWB files such as ‘sub-1001658958/sub-1001658958_ses-1003321768_icephys.nwb’. Use DANDI_search_datasets to find a dandiset_id.

Parameters:

  • dandiset_id (string) (required) DANDI dataset identifier, e.g. ‘000020’.

  • limit ([‘integer’, ‘null’]) (optional) Max assets to return, 1-200. Default 50.

Example Usage:

query = {
    "name": "DANDI_list_assets",
    "arguments": {
        "dandiset_id": "example_value"
    }
}
result = tu.run(query)

DANDI_search_datasets (Type: DANDITool)#

Search the DANDI Archive for neurophysiology datasets in the NWB (Neurodata Without Borders) stan…

DANDI_search_datasets tool specification

Tool Information:

  • Name: DANDI_search_datasets

  • Type: DANDITool

  • Description: Search the DANDI Archive for neurophysiology datasets in the NWB (Neurodata Without Borders) standard: electrophysiology, optical physiology, and behavior recordings, mostly from the Allen Institute and BRAIN Initiative labs. Example: query=’mouse visual cortex’ or query=’patch-seq’. Returns each dataset’s dandiset_id for use with DANDI_get_dataset and DANDI_list_assets.

Parameters:

  • query (string) (required) Free-text search, e.g. ‘mouse visual cortex’, ‘patch-seq’, ‘calcium imaging’.

  • limit ([‘integer’, ‘null’]) (optional) Max dandisets to return, 1-100. Default 25.

Example Usage:

query = {
    "name": "DANDI_search_datasets",
    "arguments": {
        "query": "example_value"
    }
}
result = tu.run(query)