Submission System

From Dryad wiki
Revision as of 12:32, 28 April 2011 by Ryan Scherle (talk | contribs) (Design history)

Jump to: navigation, search

Overview

Dryad's submission system allows users to quickly and easily submit data packages. Key features include:

  1. Integration with journals -- allowing authors to automatically fill the Dryad forms with information from the journal's description of an article, and automatically notifying journal editors when a Dryad submission is completed.
  2. Minimal description requirements -- Dryad minimizes the amount of typing/clicking required by submitters. Descriptions are automatically propagated from the article description to descriptions for individual data files. Reasonable defaults are set for the various choices available.
  3. Integration with partner repositories -- allowing submitters to use Dryad information as a starting point for submitting content to another repository.

Instructions

An overview of the Dryad submission process can be seen in the Dryad submission video.


Workflow for a New Article

  1. Journal accepts the author's publication.
  2. Journal mails Dryad with metadata.
  3. Journal mails author acceptance letter, which contains a link to the Dryad submission for that publication. If the primary corresponding author of the article is not the primary manager of the data set, the article author may forward the email to the data set author.
    1. Author follows the link, which has the form: http://datadryad.org/submit?journalID=zzzz&manu=xxxx
    2. The link redirects to the DSpace aspect that handles submission: http://datadryad.org/dryadsubmit/jsubmit?journalID=zzzz&manu=xxxx
    3. Author logs in to Dryad (or creates an account). (Media:SubmissionMockupLogin.png)
    4. Author is presented with a publication page that allows "Edit Publication Details" and "Add Dataset". (Media:SubmissionMockupPubSummary.png)
    5. Author may expand metadata for the publication. (Media:SubmissionMockupJournalPub.png)
    6. Author uploads data, providing additional metadata for each data set. (Media:SubmissionMockupDataset.png). The author may also include a "README" file with additional documentation (see a Dryad record with a README file).
    7. Author may provide IDs of data sets in other repositories.
    8. Author may provide IDs of pre-existing data sets in Dryad.
    9. Author may choose to place data sets under embargo. (Default embargo period lasts until 1 year from the publication date.
    10. Author chooses to "Publish Datasets". (Media:SubmissionMockupPubSummary.png)
  4. Dryad mails handle of publication record to journal editor. (At least one dataset must be present.)
  5. Journal editors may include the Dryad handle in the article.
  6. Journal sends the table of contents (including DOI list) for each issue to Dryad, so complete metadata can be extracted and the embargo period can officially start.
    • This may be the same information that is sent to Crossref and/or PubMedCentral.

Workflow for an Article in a non-partner Journal

  1. Author logs in to Dryad (or creates an account).
  2. Author chooses "Deposit Data for a New Publication".
  3. Author is presented with an "Add Publication" page. This page looks similar to the "Edit Publication Details" page from the partner journal process, but all fields may be edited (and are initially blank). (Media:SubmissionMockupCreateNewPublication.png)
  4. Author is presented with a publication page that allows "Edit Publication Details" and "Add Dataset".
  5. Author may edit/expand metadata for the publication.
  6. Author uploads data, providing additional metadata for each data set.
  7. Author may provide IDs of data sets in other repositories.
  8. Author may provide IDs of pre-existing data sets in Dryad.
  9. Author may choose to place data sets under embargo. (Default embargo period lasts until 1 year from the publication date.
  10. Author chooses to "Publish Datasets".


Technical Documentation

Email Parsing System

  1. Email sent to a short perl script (journalEmailGateway.pl), which forwards the contents of the message to a web service.
  2. The web service (journal-submit) parses the contents of the email.
    • Parsing can be different for each journal, though most journals use the Manuscript Central template created by Tim Vines.
    • The parsed content is stored as an XML file in submission/journalMetadata.
  3. When an author follows a link (or enters an equivalent journalID and manuscript number into the submission web form), the submission system will import the relevant XML file to pre-populate metadata for the new submission.


Design history

Mockups of submission features:

See also the list of Use Cases and the Partner Submission Integration.