Skip to content
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.

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

DOC: update docs to agree with latest state of codebase #260

Merged
merged 11 commits into from
Mar 17, 2023
5 changes: 0 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,6 @@ from `OHBM BrainHack 2022 <https://github.com/ohbm/hackathon2022/issues/43>`__,
and is the result of a wonderful collaboration between `many awesome people <https://github.com/datalad/datalad-dataverse#contributors->`__.
If you want to get in touch or on board as well, please see our :ref:`contributing guidelines <contribute>`.

.. attention:: **This extension is undergoing continous development and is in alpha stage!**

Nevertheless, thanks for your interest in this piece of software! If you want to work with it
productively, we recommend that you come back in a few weeks, when we had some post-hackathon
time to package it up properly and complete documentation and tutorials.

Documentation overview
======================
Expand Down
9 changes: 5 additions & 4 deletions docs/source/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ What can I use this extension for?
You can use this extension to publish and share your dataset via Dataverse_, and you can use it to clone published DataLad datasets from Dataverse_.
Here is some inspiration on what you could do:

- Publish your study (including its version history, data, code, results, and provenance) as a DataLad dataset to Dataverse to share it with collaborators or get a DOI for it.
- Share a published datasets' URL with colleagues and collaborators to give them easy access to your work with a single ``datalad clone``.
- Clone a friend's DataLad dataset -- from Dataverse!
- **Publish your study** (including its version history, data, code, results, and provenance) as a DataLad dataset to Dataverse to share it with collaborators or get a DOI for it.
- **Share a published dataset's URL** with colleagues and collaborators to give them easy access to your work with a single ``datalad clone``.
- **Clone a friend's DataLad dataset** -- from Dataverse!


``datalad-dataverse`` comes with a range of hidden convenience functions for Dataverse interactions.
Expand All @@ -70,4 +70,5 @@ What can I **not** use this extension for?
Please refer to the list of `special remotes`_ as hosted by the `git-annex`_ website for other storage services and how to use them with DataLad.
- Dataverse installations may have upload or storage limits - exceeding those limits is not possible with this tool. However, you will be able to at least publish the revision history of your dataset even if annexed files are too large.
- The starting point for working with this extension is a (published) DataLad dataset, not a regular Dataverse dataset.
This extension will not transform normal Dataverse datasets projects into DataLad datasets, but expose DataLad datasets as Dataverse datasets.
This extension will not transform normal Dataverse datasets projects into DataLad datasets, but expose DataLad datasets as Dataverse datasets.
- Please see the :ref:`feature support <feature_support>` section for particulars of what is and is not supported by this extension package.
38 changes: 26 additions & 12 deletions docs/source/settingup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,20 @@ The relevant requirements are listed below.
If you don't have DataLad_ and its underlying tools (`git`_, `git-annex`_) installed yet, please follow the instructions from `the datalad handbook <http://handbook.datalad.org/en/latest/intro/installation.html>`_.


Installation
^^^^^^^^^^^^
.. _feature_support:

Feature support
^^^^^^^^^^^^^^^^
``datalad-dataverse`` is developed to be compatible with Dataverse (version 5.13), which
has certain limitations when integrated with DataLad. In particular:

.. attention:: **This extension is undergoing continous development and is in alpha stage!**
- This extension does not support Dataverse versions prior to v5.13
- This extension does not support unicode in filenames
- Support for handling previously published Dataverse datasets is experimental
mih marked this conversation as resolved.
Show resolved Hide resolved

Nevertheless, thanks for your interest in this piece of software! If you want to work with it
productively, we recommend that you come back in a few weeks, when we had some post-hackathon
time to package it up properly and complete documentation and tutorials. We didn't quite make it
to the release during the Hackathon, so regard the instructions below as how it will work in the
future.

Installation
^^^^^^^^^^^^

``datalad-dataverse`` is a Python package available on `pypi <https://pypi.org/project/datalad-dataverse/>`_ and installable via pip_.

Expand All @@ -43,12 +46,23 @@ Installation
Getting started
^^^^^^^^^^^^^^^

Here's the gist of some of this extension's functionality.
Checkout the Tutorial for more detailed demonstrations.
The ``datalad-dataverse`` software allows publishing a DataLad dataset to a Dataverse
instance. First ensure that your dataset is packaged as a DataLad dataset:

.. code-block:: bash

datalad create -d [dataset_location] --force

Then create a dataverse `sibling` to the DataLad dataset:

.. code-block:: bash

datalad add-sibling-dataverse -s dataverse -d [dataset_location] demo.dataverse.org
jsheunis marked this conversation as resolved.
Show resolved Hide resolved


jsheunis marked this conversation as resolved.
Show resolved Hide resolved
.. attention:: **This extension is undergoing continous development and is in alpha stage!**
.. admonition:: TODO

Sadly, there is no gist and no tutorial yet - come back a bit later, or help us create one :)
Add basic datalad-dataverse commands for publishing to and cloning from dataverse

.. admonition:: HELP! I'm new to this!

Expand Down