Home
Fundamentals
Research Data Management
FAIR Data Principles
Metadata
Ontologies
Data Sharing
Data Publications
Data Management Plan
Version Control & Git
Public Data Repositories
Persistent Identifiers
Electronic Lab Notebooks (ELN)
DataPLANT Implementations
Annotated Research Context
ARC specification
ARC Commander
Swate
MetadataQuiz
DataHUB
DataPLAN
Ontology Service Landscape
ARC Commander Manual
Setup
Git Installation
ARC Commander Installation
Windows
MacOS
Linux
ARC Commander DataHUB Access
Before we start
Central Functions
Initialize
Clone
Connect
Synchronize
Configure
Branch
ISA Metadata Functions
ISA Metadata
Investigation
Study
Assay
Update
Export
ARCitect Manual
Installation - Windows
Installation - macOS
Installation - Linux
QuickStart
QuickStart - Videos
ARCmanager Manual
What is the ARCmanager?
Connect to your DataHUB
View your ARCs
Create new ARCs
Add new studies and assays
Upload files
Add metadata to your ARCs
Swate Manual
QuickStart
QuickStart - Videos
Annotation tables
Building blocks
Building Block Types
Adding a Building Block
Filling cells with ontology terms
Advanced Term Search
File Picker
Templates
Contribute Templates
ISA-JSON
DataHUB Manual
Overview
User Settings
Generate a Personal Access Token (PAT)
Projects Panel
ARC Panel
Forks
Working with files
ARC Settings
ARC Wiki
Groups Panel
Create a new user group
CQC Pipelines & validation
Find and use ARC validation packages
Data publications
Passing Continuous Quality Control
Submitting ARCs with ARChigator
Track publication status
Use your DOIs
Guides
ARC User Journey
Create your ARC
ARCitect QuickStart
ARCitect QuickStart - Videos
ARC Commander QuickStart
ARC Commander QuickStart (Experts)
Annotate Data in your ARC
Annotation Principles
ISA File Types
Best Practices For Data Annotation
Swate QuickStart
Swate QuickStart - Videos
Swate Walk-through
Share your ARC
Register at the DataHUB
DataPLANT account
Invite collaborators to your ARC
Sharing ARCs via the DataHUB
Work with your ARC
Using ARCs with Galaxy
Computational Workflows
CWL Introduction
CWL runner installation
CWL Examples
CWL Metadata
Recommended ARC practices
Syncing recommendation
Keep files from syncing to the DataHUB
Managing ARCs across locations
Working with large data files
Adding external data to the ARC
ARCs in Enabling Platforms
Publication to ARC
Troubleshooting
Git Troubleshooting & Tips
Contribute
Swate Templates
Knowledge Base
Teaching Materials
Events 2023
Nov: CEPLAS PhD Module
Oct: CSCS CEPLAS Start Your ARC
Sept: MibiNet CEPLAS Start Your ARC
July: RPTU Summer School on RDM
July: Data Steward Circle
May: CEPLAS Start Your ARC Series
Start Your ARC Series - Videos
Events 2024
TRR175 Becoming FAIR
CEPLAS ARC Trainings – Spring 2024
MibiNet CEPLAS DataPLANT Tool-Workshops
TRR175 Tutzing Retreat
Frequently Asked Questions
last updated at 2024-03-06
About this guide
In this guide we explain the different ways offered by the DataHUB to share an ARC with collaborators.
Before we can start
☑️ You have a DataPLANT account
💡 See the DataHUB manual for tutorials
DataHUB concepts and terminology
Before jumping into the details of data sharing, we need to introduce a few DataHUB concepts, settings and terms that tend to be confusing for new users.
"Projects" and "Groups" are not the same
Project = ARC
- In the DataHUB, ARCs are called "projects"; they are the same.
- An ARC can be shared with individual users (invited as "members") or a group.
DataHUB Groups
- A "Group" is a group of users (then "members" of that group) with specific permissions.
- A group (e.g. your lab or consortium) can share ARCs.
- Groups help you communicate with all group members and manage permissions for the ARCs shared in that group.
- Depending on their assigned roles, members of the group can view, edit, delete, and / or maintain the ARCs of that group.
- If someone has access to a group, they get access to all the ARC in the group.
- The group Owner(s) can adjust group settings and manage group memberships.
- Groups can have subgroups (with a subset of members). Subgroups have the same features as groups.
Namespaces
- In the DataHUB, namespaces help organize related projects.
- Every user has a personal namespace, where they can upload or create new ARCs.
- Every group and subgroup has an own namespace, respectively.
You can check the namespace by looking at the URL. For example:
💡 "Personal" is not the same as "private", see visibility.
Visibility
The visibility of ARCs and groups can be managed individually for each ARC (see ARC settings) or group see (Creating a Group).
- Private – Access must be granted explicitly to each user or a group.
- Internal – Can be accessed by any logged in user.
- Public – Can be accessed without authentication.
💡 By default every ARC and every group is set to private.
Roles and permissions
If you create or upload an ARC to the DataHUB, you are the Owner by default.
When inviting new members to an ARC or group, you can choose between different levels.
- Guest – Has the least rights. They will not be able to see the content of an ARC (only the wiki page).
- Reporter – Has read access to your ARC. This is recommended for people you ask for consultancy.
- Developer – The choice for most people you want to invite to your ARC. Developers have read and write access, but cannot maintain the project on the DataHUB, e.g. invite new members.
- Maintainer – Has read and write access and can add or remove members, except for yourself. This is the minimum role recommended for inviting group leaders as it allows them to add their group members for data upload or analysis to the project.
- Owner – An owner has basically all rights to the ARC. They can delete or transfer the ARC and manage user memberships.
💡 A detailed list of all permissions for the individual roles can be found here
ARC members in the DataHUB are not the same as ARC contacts in ISA metadata
Data in the ARC can be annotated with metadata. Metadata annotation in the ARC is based on the ISA metadata model and includes several points to add the the contributors to the overall investigation (→ "Investigation Contacts"), one linked study (→ "Study Contacts" of that study), or one linked assay (→ "Assay Performers" of that assay). For all three types of contributors, contact information (e.g. first and last name, affiliation,ORCID, email) can be added.
Although the contacts added to the ARC's metadata may be the same persons as those added as members to the ARC in the DataHUB, there is currently no automation involved:
- Contributors added to an ARC's metadata are not automatically invited to or notified about the ARC in the DataHUB.
- And vice versa, members invited to an ARC in the DataHUB are not automatically added to any ISA metadata in the ARC.
Creating an ARC with contributors and uploading it to the DataHUB is conceptually, the same as creating a manuscript with authors for publication and sharing it via any cloud service. You can invite members to your DataHUB-shared ARC just as you can invite collaborators to your cloud-shared manuscript and these may not be the same legal people as added to your investigation contacts (ARC) or author list (manuscript).
💡 Members, groups, and roles set via the DataHUB can easily be confused with contributors added as ISA metadata to an ARC, e.g. collaborators added to investigation, study or assay. These are not the same and they are not automatically synced.
Options to share an ARC via the DataHUB
To suit a wide range of collaborative scenarios, the DataHUB offers multiple, flexible ways of sharing an ARC.
This flexibility can be confusing at first. Generally, ARCs can be uploaded to the DataHUB and (a) associated to the namespace of a user account (the default) or (b) the namespace of a group.
The figure below is supposed to give a quick overview. Once an ARC exists in the DataHUB, you can choose between these options to share the ARC with collaborators.
- You can invite individual users (1). This is helpful to share an ARC with selected colleagues.
- To share an ARC with a group of users (e.g. a lab or consortium), you can invite a group (2).
In both cases (1 and 2), the ARC "stays associated" with the original owner only (visible by the namespace and URL address). Furthermore the roles and permissions can be set for individual users and groups.
Alternatively, you can create a fork of your ARC (3). This generates a copy linked to the original ARC, but now associated with the group. This can be used to share an ARC at a certain stage, without sharing the full progress after that stage. However, since the two ARCs (the original and the fork) can now be developed independently. This can easily lead to divergence and requires a bit more technical expertise to keep both ARCs in sync (if desired).
Finally, you can transfer your ARC to a group (4). This moves the ARC to new namespace (that of the group).
In both cases 3 and 4, you must have at least maintainer access to the group.
If you have maintainer access, you can also directly create or upload an ARC to a group.
DataPLANT Support
Besides these technical solutions, DataPLANT supports you with community-engaged data stewardship. For further assistance, feel free to reach out via our
helpdesk
or by contacting us
directly
.