https://github.com/iqss/dataverse-binder-redirect

https://github.com/iqss/dataverse-binder-redirect

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/iqss/dataverse-binder-redirect
• Owner: IQSS
• License: apache-2.0
• Created: 2024-03-11T14:50:34.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-11T20:41:38.000Z (over 2 years ago)
• Last Synced: 2024-04-16T03:47:52.746Z (about 2 years ago)
• Language: HTML
• Homepage: https://iqss.github.io/dataverse-binder-redirect/
• Size: 7.81 KB
• Stars: 0
• Watchers: 18
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Dataverse Binder Redirect

To use Binder with Dataverse, please install the following [external tool][] manifest.

[external tool]: https://guides.dataverse.org/en/latest/admin/external-tools.html

Once you do, a "Binder" button will appear under "Access Dataset". Clicking that button will send the user to a static page hosted on GitHub Pages (the code in this repo). The static page places the DOI of a dataset into a URL that Binder can understand and then redirects the user there.

For example, the user may click "Binder" and land on the static page at https://iqss.github.io/dataverse-binder-redirect/v1/?datasetPid=doi:10.7910/DVN/TJCLKP which will send the user to https://mybinder.org/v2/dataverse/10.7910/DVN/TJCLKP/

Please note that this redirect page will no longer be required once the Dataverse external tool framework supports putting parameters in the path (rather than just the query parameters) of a URL ([#9345](https://github.com/IQSS/dataverse/issues/9345)).

```bash

curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \

'{

  "displayName": "Binder",

  "toolName": "binderExplorer",

  "description": "Run on Binder",

  "scope": "dataset",

  "type": "explore",

  "toolUrl": "https://iqss.github.io/dataverse-binder-redirect/v1/",

  "toolParameters": {

    "queryParameters": [

      {

        "datasetPid": "{datasetPid}"

      }

    ]

  }

}'

```