Skip to content

8063 Tworavens Example Manifest Update, Disclaimer #8083

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kcondon merged 3 commits into from
Sep 1, 2021
Merged

8063 Tworavens Example Manifest Update, Disclaimer #8083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d499d6d
updating the tworavens manifest so it works
djbrooke Aug 31, 2021
a293fd2
update links, add disclaimer
djbrooke Aug 31, 2021
582f85e
feedback from code review
djbrooke Sep 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion doc/sphinx-guides/source/_static/installation/files/root/external-tools/twoRavens.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
{
"displayName": "TwoRavens",
"description": "A system of interlocking statistical tools for data exploration, analysis, and meta-analysis.",
"toolName": "TwoRavens",
"scope": "file",
"type": "explore",
"toolUrl": "https://tworavens.dataverse.example.edu/dataexplore/gui.html",
"contentType": "text/tab-separated-values",
"toolParameters": {
"queryParameters": [
{
Expand All @@ -14,4 +16,4 @@
}
]
}
}
}
5 changes: 3 additions & 2 deletions doc/sphinx-guides/source/installation/r-rapache-tworavens.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Any questions regarding the features of TwoRavens, bug reports and
such, should be addressed directly to the developers of the
application. The `TwoRavens GitHub repository
<https://github.com/IQSS/TwoRavens>`_ and the `TwoRavens project page
<http://2ra.vn/community/index.html>`_ are good places to start.
<http://2ra.vn/index.html>`_ are good places to start.

For now, the Dataverse Project team will continue providing
installation and integration support. We have created a new (as
Expand Down Expand Up @@ -343,7 +343,8 @@ e. Enable TwoRavens in a Dataverse Installation

Now that you have installed TwoRavens, you can make it available to your users by adding it an "external tool" for your Dataverse installation. (For more on external tools in general, see the :doc:`/admin/external-tools` section of the Admin Guide.)

First, download :download:`twoRavens.json <../_static/installation/files/root/external-tools/twoRavens.json>` as a starting point and edit ``toolUrl`` in that external tool manifest file to be the URL where you want TwoRavens to run. This is the URL reported by the installer script (as in the example at the end of step ``c.``, above).
First, download :download:`twoRavens.json <../_static/installation/files/root/external-tools/twoRavens.json>` as a starting point and edit ``toolUrl`` in that external tool manifest file to be the URL where you want TwoRavens to run. This is the URL reported by the installer script (as in the example at the end of step ``c.``, above). Please note that this example .json file is not maintained by the TwoRavens developers and may be out of date. For an updated file, contact the `TwoRavens team
<http://2ra.vn/aboutus/aboutus.html>`_.

Once you have made your edits, make the tool available within your Dataverse installation with the following curl command (assuming ``twoRavens.json`` is in your current working directory):

Expand Down