datalad-dataverse

A DataLad (www.datalad.org) extension to work with Dataverse

https://github.com/datalad/datalad-dataverse

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    8 of 27 committers (29.6%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (17.4%) to scientific vocabulary

Keywords

closember datalad

Keywords from Contributors

rdm data-storage git-annex usable neuroimaging bids brain-imaging fmri brainweb data-standards
Last synced: 6 months ago · JSON representation ·

Repository

A DataLad (www.datalad.org) extension to work with Dataverse

Basic Info
  • Host: GitHub
  • Owner: datalad
  • License: other
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 1.64 MB
Statistics
  • Stars: 9
  • Watchers: 5
  • Forks: 14
  • Open Issues: 28
  • Releases: 4
Topics
closember datalad
Created over 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

DataLad extension for working Dataverse

Build status codecov Documentation Status License: MIT GitHub release PyPI version fury.io <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> All Contributors <!-- ALL-CONTRIBUTORS-BADGE:END -->

Dataverse is open source research data repository software that is deployed all over the world as data or metadata repositories. It supports sharing, preserving, citing, exploring, and analyzing research data with descriptive metadata, and thus contributes greatly to open, reproducible, and FAIR science. DataLad, on the other hand, is a data management and data publication tool build on Git and git-annex. Its core data structure, DataLad datasets, can version control files of any size, and streamline data sharing, updating, and collaboration. This DataLad extension package provides interoperablity with Dataverse to support dataset transport to and from Dataverse instances.

Installation

```

create and enter a new virtual environment (optional)

$ virtualenv --python=python3 ~/env/dl-dataverse $ . ~/env/dl-dataverse/bin/activate

install from PyPi

$ python -m pip install datalad-dataverse ```

How to use

Additional commands provided by this extension are immediately available after installation. However, in order to fully benefit from all improvements, the extension has to be enabled for auto-loading by executing:

git config --global --add datalad.extensions.load dataverse

Doing so will enable the extension to also alter the behavior the core DataLad package and its commands, from example to be able to directly clone from a Dataverse dataset landing page.

Full-compatibility with Windows requires a git-annex installation of version 10.20230321 (or later).

Summary of functionality provided by this extension

  • Interoperability between DataLad and Dataverse version 5 (or later).
  • A add-sibling-dataverse command to register a Dataverse dataset as remote sibling for a DataLad dataset.
  • A git-annex-remote-dataverse special remote implementation for storage and retrieval of data in Dataverse dataset via git-annex.
  • These two features combined enable the deposition and retrieveal of complete DataLad dataset on Dataverse, including version history and metadata. A direct datalad clone from a Dataverse dataset landing page is supported, and yields a fully functional DataLad dataset clone (Git repository).

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Johanna Bayer
Johanna Bayer

📖
Nadine Spychala
Nadine Spychala

🚇 📖
Benjamin Poldrack
Benjamin Poldrack

🚇 💻 📖 🚧 👀 🤔 🔧
Adina Wagner
Adina Wagner

💻 🤔 🚇 📖 🚧 👀
Michael Hanke
Michael Hanke

💻 🤔 🚧 🚇 👀 🔧
enicolaisen
enicolaisen

📖
Roza
Roza

📖
Kelvin Sarink
Kelvin Sarink

💻
Jan Ernsting
Jan Ernsting

💻
Chris Markiewicz
Chris Markiewicz

💻
Alex Waite
Alex Waite

🚇 💻 🚧 🔧
Shammi270787
Shammi270787

💻
Wu Jianxiao
Wu Jianxiao

💻 👀 📓
Laura Waite
Laura Waite

📖
Michał Szczepanik
Michał Szczepanik

🚇
Benedikt Ehinger
Benedikt Ehinger

🐛 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!

Acknowledgements

This DataLad extension was developed with support from the German Federal Ministry of Education and Research (BMBF 01GQ1905), the US National Science Foundation (NSF 1912266), the Helmholtz research center Jülich (RDM challenge 2022), and the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under grant SFB 1451 (431549029, INF project).

Owner

  • Name: DataLad
  • Login: datalad
  • Kind: organization
  • Email: team@datalad.org
  • Location: USA&Germany

Data distribution and management platform

Citation (CITATION.cff)

cff-version: 1.2.0
title: datalad-dataverse
message: If you use this software, please cite it using these metadata.
authors:
  - family-names: Poldrack
    given-names: Benjamin
    orcid: "https://orcid.org/0000-0001-7628-0801"
  - family-names: Wagner
    given-names: Adina
    orcid: "https://orcid.org/0000-0003-2917-3450"
  - family-names: Ernsting
    given-names: Jan
    affiliation: >-
      University of Münster, Institute for Translational Psychiatry, Münster, Germany;
      University of Münster, Faculty of Mathematics and Computer Science, Münster, Germany
    orcid: "https://orcid.org/0000-0003-4649-2111"
  - family-names: Hanke
    given-names: Michael
    orcid: "https://orcid.org/0000-0001-6398-6370"
  - family-names: Roza Gunes
    given-names: Bayrak
    affiliation: Vanderbilt University, Nashville, TN USA
    orcid: "https://orcid.org/0000-0002-7197-1248"
  - family-names: Sarink
    given-names: Kelvin
    affiliation: University of Münster, Institute for Translational Psychiatry, Münster, Germany
    orcid: "https://orcid.org/0000-0002-4840-5619"
  - family-names: Nicolaisen-Sobesky
    given-names: Eliana
    affiliation: "Institute of Neuroscience and Medicine (INM-7: Brain and Behaviour), Research Centre Jülich, Jülich, Germany."
    orcid: "https://orcid.org/0000-0002-4806-2863"
  - family-names: More
    given-names: Shammi
    orcid: "https://orcid.org/0000-0002-1272-217X"
  - family-names: Bayer
    given-names: Johanna
    affiliation: >-
      The University of Melbourne, Melbourne, Australia;
      Orygen Youth Health, Melbourne, Australia
    orcid: "https://orcid.org/0000-0003-4891-6256"
  - family-names: Markiewicz
    given-names: Christopher J
    affiliation: Stanford University
    orcid: "https://orcid.org/0000-0002-6533-164X"
  - family-names: Waite
    given-names: Alex
    orcid: "https://orcid.org/0000-0002-8402-6173"
  - family-names: Spychala
    given-names: Nadine
    orcid: "https://orcid.org/0000-0003-2582-9758"
  - family-names: Waite
    given-names: Laura
    orcid: "https://orcid.org/0000-0003-2213-7465"
  - family-names: Wu
    given-names: Jianxiao
    orcid: "https://orcid.org/0000-0002-4866-272X"
  - family-names: Mönch
    given-names: Christian
    orcid: "https://orcid.org/0000-0002-3092-0612"
  - family-names: Heunis
    given-names: Stephan
    orcid: "https://orcid.org/0000-0003-3503-9872"
keywords:
  - Computational reproducibility
  - reproducibility
  - Python
  - data management
  - workflow

GitHub Events

Total
  • Create event: 3
  • Release event: 1
  • Issues event: 4
  • Delete event: 1
  • Issue comment event: 11
  • Push event: 2
  • Pull request event: 3
Last Year
  • Create event: 3
  • Release event: 1
  • Issues event: 4
  • Delete event: 1
  • Issue comment event: 11
  • Push event: 2
  • Pull request event: 3

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 466
  • Total Committers: 27
  • Avg Commits per committer: 17.259
  • Development Distribution Score (DDS): 0.532
Past Year
  • Commits: 198
  • Committers: 11
  • Avg Commits per committer: 18.0
  • Development Distribution Score (DDS): 0.394
Top Committers
Name Email Commits
Michael Hanke m****e@g****m 218
Adina Wagner a****r@t****e 61
Benjamin Poldrack b****k@g****m 46
allcontributors[bot] 4****] 34
Jan Ernsting j****g@u****e 14
Christian Monch c****h@w****e 14
John T. Wodder II g****t@v****g 13
enicolaisen e****n@g****m 10
Yaroslav Halchenko d****n@o****m 9
Kelvin Sarink k****k@u****e 8
Michał Szczepanik m****k@f****e 6
Wu Jianxiao j****a@g****m 6
Stephan Heunis s****s@f****e 5
Roza 2****k 4
Benjamin Poldrack b****k 4
Nadine n****a@g****m 2
Johanna Bayer j****r@o****u 2
Alex Waite a****x@w****u 1
Laura Waite l****a@w****u 1
Chris Markiewicz e****s@g****m 1
Matthias Riße m****e@f****e 1
Christopher J. Markiewicz m****z@s****u 1
Benedikt Ehinger b****r@v****e 1
Kelvin Sarink 2****k 1
More, Shammi s****e@f****e 1
Shammi270787 m****i@g****m 1
Stephan Heunis j****s@g****m 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 79
  • Total pull requests: 65
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 12
  • Total pull request authors: 9
  • Average comments per issue: 2.15
  • Average comments per pull request: 1.26
  • Merged pull requests: 57
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 11
  • Pull requests: 20
  • Average time to close issues: 15 days
  • Average time to close pull requests: 5 days
  • Issue authors: 5
  • Pull request authors: 3
  • Average comments per issue: 3.55
  • Average comments per pull request: 0.7
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • mih (43)
  • adswa (12)
  • bpoldrack (10)
  • shoeffner (3)
  • behinger (3)
  • pdurbin (2)
  • RalfKunkel (1)
  • jsheunis (1)
  • loj (1)
  • bpinsard (1)
  • yarikoptic (1)
  • jernsting (1)
Pull Request Authors
  • mih (32)
  • adswa (25)
  • shoeffner (10)
  • christian-monch (8)
  • bpoldrack (6)
  • behinger (1)
  • allcontributors[bot] (1)
  • yarikoptic (1)
  • jsheunis (1)
Top Labels
Issue Labels
bug (5) enhancement (3) infra (2) documentation (1) no-coding (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 337 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 4
  • Total maintainers: 2
pypi.org: datalad-dataverse

DataLad extension to deposit datasets on Dataverse

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 337 Last month
Rankings
Dependent packages count: 7.3%
Forks count: 9.6%
Average: 14.5%
Downloads: 15.8%
Stargazers count: 17.7%
Dependent repos count: 22.1%
Maintainers (2)
Last synced: 6 months ago

Dependencies

requirements-devel.txt pypi
  • sphinx *
  • sphinx_rtd_theme *
.github/workflows/docbuild.yml actions
  • actions/checkout v1 composite
  • actions/setup-python v1 composite
.github/workflows/add-changelog-snippet.yml actions
  • actions/checkout v3 composite
  • datalad/release-action/add-changelog-snippet v1 composite
.github/workflows/codespell.yml actions
  • actions/checkout v3 composite
  • codespell-project/actions-codespell v1 composite
_datalad_buildsupport/setup.py pypi
pyproject.toml pypi
setup.py pypi