NSF BioPACIFIC MIP Wiki

A National User Facility Dedicated to Biomaterials

User Tools

Site Tools


eln-guide-basic-data-dryad

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
eln-guide-basic-data-dryad [2026/04/06 20:05] csdunhameln-guide-basic-data-dryad [2026/04/06 21:51] (current) – [Step 5: Lock & Export] saejinoh
Line 12: Line 12:
  
 ===== Step 1: API token ===== ===== Step 1: API token =====
-In order to submit data to Data Dryad, you must first obtain an API token from your Data Dryad account page. Upon activating the API account, you will see the ability to generate an API token at the bottom of the page, as shown in Fig 2. Upon generating a token, it will remain active/usable for 10 years. After 10 hours, the user will need to get a new token.+In order to submit data to Data Dryad, you must first obtain an API token from your Data Dryad account page. Upon activating the API account, you will see the ability to generate an API token at the bottom of the page, as shown in Fig 2. Upon generating a token, it will remain active/usable for 10 hours. After 10 hours, the user will need to get a new token.
 \\ \\
 \\ \\
Line 77: Line 77:
 \\ \\
 \\ \\
-An important note: Data Dryad has an expectation, really a requirement, that the README file contain at least a bit of information for every file that you've uploaded as part of your dataset. This information is often expected in the form of **'[file_name]': description of file contents and how to use it correctly**. However, Data Dryad's API does not communicate information about README file deficiencies like this, nor does it allow editing of an uploaded README over the API (or, at least, those methods aren't exposed; we will revise this section if that changes). A consequence of this is that we are not able to enforce some of Dryad's README conventions in the ELN's README editor, and so, you will need to reconcile discrepancies via the Data Dryad website (reminder: you can always access the Data Dryad website for your dataset by clicking the 'Link to Dryad' link on the dataset card).+**An important note:** Data Dryad has an expectation, really a requirement, that the README file contain at least a bit of information for every file that you've uploaded as part of your dataset. This information is often expected in the form of //**'[file_name]': description of file contents and how to use it correctly**//. However, Data Dryad's API does not communicate information about README file deficiencies like this, nor does it allow editing of an uploaded README over the API (or, at least, those methods aren't exposed; we will revise this section if that changes). A consequence of this is that we are not able to enforce some of Dryad's README conventions in the ELN's README editor, and so, you will need to reconcile discrepancies via the Data Dryad website (reminder: you can always access the Data Dryad website for your dataset by clicking the 'Link to Dryad' link on the dataset card).
  
 ---- ----
  
 ===== Step 5: Lock & Export ===== ===== Step 5: Lock & Export =====
-TBD...+Once you've finished sending files to Dryad, editing your Dataset's metadata, and formatting your README file, the time will come to close up shop for this Dataset and lock and export your README file to Data DryadThis is where the Lock & Export feature is usedClicking this button reveals a form field for your Dryad API tokenUpon providing the token and clicking Confirm Export, another dialog box will pop up to remind you of the consequences of this action: the editor will become locked, editing the Dataset metadata in the Launchpad utility will be disabled, and files will no longer be available to upload to Dryad from this dataset. In short, it deactivates all mechanisms to send data from the Launchpad Dataset to Dryad. Please make sure this is the action you want and are ready for!
  
 ====== Launchpad Caveats ====== ====== Launchpad Caveats ======
eln-guide-basic-data-dryad.1775505904.txt.gz · Last modified: by csdunham