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 User Journey ARC specification ARC Commander QuickStart QuickStart (Experts) Swate QuickStart Walk-through Best Practices For Data Annotation 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? How to use the ARCmanager Swate Manual 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 Data publications Passing Continuous Quality Control Submitting ARCs with ARChigator Track publication status Use your DOIs Guides ARC User Journey Create your ARC ARC Commander QuickStart ARC Commander QuickStart (Experts) ARCitect QuickStart Annotate Data in your ARC Annotation Principles ISA File Types Best Practices For Data Annotation Swate QuickStart 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 Working with large data files Adding external data to the ARC ARCs in Enabling Platforms Publication to ARC Troubleshooting Git Troubleshooting 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 CEPLAS ARC Trainings – Spring 2024 MibiNet CEPLAS DataPLANT Tool-Workshops Frequently Asked Questions

Syncing recommendation

last updated at 2023-06-27 About this guide

In this guide we elaborate recommendations on syncing your ARC via the ARC Commander

UserAdvanced ModeTutorial

⚠️ This guide presents an interim solution. We are working on a more user-friendly implementation.

Before we can start

☑️ You have created an ARC before using the ARC Commander
☑️ The latest version of the ARC Commander is installed on your computer
☑️ You have a DataPLANT account
☑️ Your computer is linked to the DataHUB via personal access token

You have full control

Unlike what you are used to from common cloud services, none of the ARC tools automatically or passively syncs your ARC between your computer and the DataHUB. You have to actively sync it. What may appear as an unwanted burden – "Why do I have to do this myself?" – actually grants you full access over what is happening with your ARC. First, it allows you to avoid syncing unwanted changes. For instance, consider adding a large amount of data, that may take some time to be uploaded into the DataHUB. You surely would want to decide yourself when to start the upload. Secondly, it allows you document your ARC's progress step by step. In general, the more you work with your ARC, the more you add or update, annotate or analyze data, the more you will want to make sure these changes are saved. Consider the syncing as a way to backup your project's progress as well as an "undo button".

💡 In the DataHUB, the individual sync steps are called "commit".

Add a message to communicate your ARC's evolution

We recommend adding a message that shortly summarizes, what you did since you last synced your ARC.

For instance:

  1. You start a fresh ARC for your project
arc sync -m "initialized ARC structure"
  1. You add folders for your study and assay
arc sync -m "added folder structure"
  1. You add the raw data to an RNASeq assay
arc sync -m "added RNAseq dataset"
  1. You annotate the dataset using Swate
arc sync -m "annotate RNAseq samples"

💡 If no commit message is added, the ARC Commander by default adds the commit message "Update" during arc sync.

Follow your progress in the DataHUB

You can actually see all arc sync actions (i.e. commits) to your ARC in the DataHUB.

  1. Open your ARC in the DataHUB
  2. In the sidebar on the left, navigate to RepositoryCommits.
  3. There you find a chronological list of syncing messages together with who synced (if you collaborate with others on an ARC) and when.
Undo latest changes
  1. Click on the latest (i.e. uppermost) commit.
  2. In the top-right corner select Revert from the drop-down menu Options.
  1. Un-check the box "Start a new merge request with these changes".
  2. Click "Revert"

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 .
Contribution Guide 📖
✏️ Edit this page