Integrating with Whole Tale

The Whole Tale platform provides several integration options for remote repositories including:

  • Data registration: allows users to import and reference data from your repository
  • “Analyze in Whole Tale”: allows users to launch interactive analysis environments using data or Tales published in your repository
  • Tale publishing: allows users to publish Tale packages to your repository

Data registration

Whole Tale enables users to import and work with datasets from a variety of remote resources. After registering data, users can launch interactive analysis environment and package new Tales that reference the data stored on remote systems.

As of release v0.8, supported data providers include:

  • HTTP: any data accessible via HTTP protocol
  • DataONE: any dataset available through the DataONE network
  • Dataverse: any dataset available through the Dataverse network
  • Globus: data available through the Materials Data Facility (MDF)

New data providers can be added by extending the Girder Whole Tale plugin.

Analyze in Whole Tale

The “Analyze in Whole Tale” feature enables one-stop data registration and Tale creation from remote repositories. Remote systems simply construct a URL pointing to the Whole Tale integration/ endpoint providing the URI for a dataset, optional Tale name and environment. Note that this requires that the provided URI is supported by one of the above data registration providers.

For example, the following URL will open the Browse page with the Tale name, data, and environment pre-populated: https://girder.dev.wholetale.org/api/v1/integration/dataone?uri=doi:10.7910/DVN/29911&name=MyTale&environment=rstudio

../_images/compose.png

Pre-populated New Tale Modal

After selecting Launch New Tale, the user will be taken to an RStudio environment with the selected dataset mounted under /data.

Dataverse External Tools

Whole Tale provides specific integration with Dataverse via the External Tools feature.

The following External Tools manifest can be used to enable Whole Tale integration on your Dataverse installation:

{
  "displayName": "Whole Tale",
  "description": "Analyze in Whole Tale",
  "scope": "dataset",
  "type": "explore",
  "toolUrl": "https://data.wholetale.org/api/v1/integration/dataverse",
  "toolParameters": {
    "queryParameters": [
      {
        "datasetPid": "{datasetPid}"
      },
      {
        "siteUrl": "{siteUrl}"
      },
      {
        "key": "{apiToken}"
      }
    ]
  }
}

Download the manifest

To install, simply POST the manifest your instance. For example:

curl -X POST -H 'Content-type: application/json' -upload-file wholetale.json  \
   http://localhost:8080/api/admin/externalTools