Skip to content

Latest commit

 

History

History
246 lines (149 loc) · 16.6 KB

submitting.md

File metadata and controls

246 lines (149 loc) · 16.6 KB

Guide for submitting to RO2019

{:.no_toc}

This page describes how authors could submit to the Workshop on Research Objects (RO2019).

tl;dr: Preprint (and additional resources) should be uploaded to the RO Zenodo community.

The Zenodo research object is submitted for review in EasyChair or GitHub

Upon acceptance, the RO2019 proceedings will link to Green Open Access preprints/ROs in Zenodo, and DOI to papers accepted for the IEEE eScience proceedings.

  • Table of Contents {:toc}

Submission types

RO2019 welcomed submissions for:

Oral Communications

  • Short articles: (about 4-8 pages) for more developed research, software or data contributions
  • Abstracts: (1-2 pages) for oral communication
  • Poster and demo abstracts: (1-2 pages)

The page limits are for guidance only, assuming reasonable font sizes and margins.

See the Call for Papers for details on topics covered at the workshop.

For any questions, email the RO2019 Workshop Organizers at ro2019@easychair.org

Unconference

Workshop participants are also encouraged to separately propose lighting talks, breakout sessions and ideas for discussion points for the unconference session of the workshop. To suggest an unconference activity, please raise an issue in GitHub.

Requirements

Unless indicated otherwise, the submitted preprint is assumed to be licensed CC-BY 4.0, and will, upon acceptance, be made available as Green Open Access on the RO2019 website with DOI links to the Zenodo record and (where applicable) DOI for the published IEEE eScience Proceedings article.

RO2019 may reformat your preprint for web publishing.

It is a requirement that at least one author of each accepted submission attends the RO2019 workshop and registers using the IEEE eScience 2019 system (either for the workshop, or the whole conference). Registration fees applies.

Formats

Submitted abstracts and articles can be in a range of open formats (e.g. HTML5, ePub) and are particularly encouraged to be submitted in a FAIR research data packing format. Guidance is provided below for those who do not have their own platform they wish to showcase.

Accepted articles will be included in the IEEE eScience 2019 proceedings; a secondary PDF, which may use the IEEE templates, may be included in the submission or provided later by the author to the IEEE submission system (camera-ready deadline for IEEE articles 29 July 2019).

Submitting

Submissions should be uploaded to the RO Zenodo community and submitted for review in EasyChair.

You may also place your submission in another open repository and provide its permalink/DOI to EasyChair. Note that we will rely on the repository for later publishing of the preprints.

See guidance below for further details.

Open Peer Review

RO2019 encourages open peer review, and recommend that reviewers are named and attributed; however reviewers may be anonymous if so desired. Reviewers are welcome to publish their reviews using the same guidelines as the research articles.

Peer reviews will be published on the RO2019 website following the workshop.

Contact

For any questions, email the RO2019 Workshop Organizers at ro2019@easychair.org

Guidance

Below are detailed instructions on how we recommend submitting your work to RO2019:

  • Author abstract/article
  • Upload to Zenodo
  • Submit for review in Easychair (or GitHub)
  • Update in Zenodo

Authoring

Use any authoring tool you prefer, as long as you can output in an open format with hyperlinks (e.g. HTML). Here is a list of some options of web-aware authoring tools:

Save your article as HTML, which may require you to use a ZIP or ePub archive to contain associated figures and CSS. You may optionally publish the preprint article on a website of your choice, and provide a URL to this during submission together with a static PDF rendering.

Word processors

Below are some legacy tools that are perhaps better at producing PDFs than web documents. If you prefer any of these you may want to use a IEEE template as starting point, then use RASH Online Conversion Service (ROCS) to convert to HTML:

If you use a legacy tool it is recommended you upload both a PDF and HTML version of your article.

Example: Google Docs

After using a word processor like Google Docs from a IEEE template, Save/Download as Web page (HTML, zipped) as well as PDF: gdoc-html

Zenodo

RO2019 promotes Open Research, and encourage authors to upload their Open Access preprint and resources to an open repository like Zenodo, an Open Data repository provided by CERN and supported by OpenAIRE.

Perhaps the simplest (lower-case) "research object" is a Zenodo record that contains:

  • Abstract/article as HTML
  • Abstract/article as PDF

If you are new to Zenodo you can play with the separate sandbox instance first, where we have provided an equivalent sandbox RO community. Note that RO2019 submissions must use the main Zenodo instead of the sandbox.

Most of the information in the Zenodo form is optional, for RO2019 it is recommended you fill in these fields:

  • Type: Conference
  • Author: Your Full Name (in your preferred order)
  • ORCID: (your ORCID  identifier)
  • Title: (same as in article)
  • Additional notes: Preprint submitted to RO2019 workshop at IEEE eScience Conference 2019
  • License: Open Access  (Note: This is the license of the preprint)
  • Abstract: (same as in article, unless the upload is an academic abstract)

You may also want to fill in Related Identifiers, in particular if your submission already have a web-version, or has related datasets, software or websites. You do not need to fill in References.

Example: Uploading to Zenodo

If you have not already done so, sign up for Zenodo. We recommended to use your ORCID account to simplify registration and login.

Then, from the Research Object Community page in Zenodo, click Upload to add a new submission. Upload to Zenodo

Now upload both the HTML and PDF version of your article: zenodo-02-upload

It is recommended to also upload (or link) to related resources that support your work. Examples:

However if these are already available in existing repositories (e.g. Zenodo, Figshare) you should instead refer to them by DOI or URL under Related Identifiers further down.

Remember to click the Start Upload button:

Start Upload

At any point you can click the Save button to store the draft (upload and metadata) under your Zenodo uploads.

Save

Now fill in Publication Type (Conference), Title and Authors. Leave DOI blank. (After acceptance you may create a New Version of this Zenodo record and provide the published DOI from the IEEE proceedings).

zenodo-03-info

If the submission is an article, provide the article's abstract as Description. (For academic abstracts you may leave this field blank or provide your own shorter abstract)

Under Additional Notes make it clear that this is a Preprint. Suggested text is:

Preprint submitted to RO2019 workshop at IEEE eScience Conference 2019 zenodo-04-notes-and-license

If you prefer a different Open Access license for your preprint, select one here. Note that the IEEE eScience Conference proceedings are unfortunately not open access, which is why we rely on the Zenodo uploads to make your accepted work available.

If you have received funding for your research, e.g. from H2020, then you may indicate this under Funding: zenodo-06-funding

If you have a web version of your submission, a website or webapp, or any related resources in other repositories that you would like to link to by DOI or URL, then add them under Related Identifiers: zenodo-07-related-identifiers

Finally, click Save followed by Publish: Save

You will need to confirm that your upload is final: zenodo-12-confirm

Now your preprint is uploaded to Zenodo: zenodo-12-ready

Copy the DOI or URL of the Zenodo Record, e.g. https://sandbox.zenodo.org/record/214634, as you will need it in the EasyChair submission for RO2019 peer review next.

Submit for review in EasyChair

After creating a Zenodo record (see above), you will need to submit it to RO2019 for review using EasyChair. You will need to signup to EasyChair if you do not already have an account.

From the RO2019 EasyChair submission page, click Enter as an Author.

Add Corresponding Author to EasyChair. As you will be submitting your Zenodo record, you are not required to add co-authors again in EasyChair, unless Corresponding Author is different from Speaker or yourself. easychair-01-author

In the EasyChair Abstract field, you do not need to duplicate the abstract from Zenodo. Simply paste the URL to the Zenodo record or the permalink to your submission in another open repository. easychair-03-no-abstract Note: If you do not provide a Zenodo record URL in the abstract, you MUST upload a PDF to EasyChair.

Select the Category of your submission type: easychair-04-category

If you created a PDF you may optionally also click Browse to upload it to EasyChair. The submitted preprint is assumed to be licensed CC-BY 4.0 unless stated otherwise.

Finally submit your contribution for consideration: easychair-05-submit

EasyChair should send you a confirmation email, and will send you more emails during the review process.

Alternative: Submit for review in GitHub

As an alternative to EasyChair, this year we also support submission of abstracts and article through GitHub. Submitting by GitHub means peer review will be done in public from day 1. If you prefer peer review to not open until acceptance, instead submit by EasyChair, as described above.

RO2019 GitHub submission procedure:

  1. Sign up to or log in at https://github.com/
  2. Create a new issue at https://github.com/researchobject/ro2019/issues - selecting the appropriate submission type
  3. For articles and longer abstracts, provide DOI for preprint uploaded at https://zenodo.org/deposit/new?c=ro
  4. For short abstracts and demo/poster submission you can instead provide the abstract in-line as text in the issue.
  5. Follow your issue to respond to peer-review as it happens (feel free to update the submission!)
  6. Browse https://github.com/ResearchObject/ro2019/issues/ - feel free to contribute ad-hoc reviews to other submissions!

Upon acceptance we will upload any inline abstracts to Zenodo to assign DOIs, assuming CC-BY-4.0 as license.

Update Zenodo

In Zenodo you can augment most of the metadata by clicking "Edit" on your record. For instance, many authors prefer to update the "Digital Object Identifier" to the DOI from the the official proceedings.

Note that the uploaded files cannot be changed. However you may update your uploads in the Zenodo record by clicking New Version. Note that reviewers are not required to assess revisions added after the deadline, but this may be used for:

  • Providing updated article, links or resources requested by reviewers
  • On acceptance of an article, uploading the IEEE camera-ready author-version PDF with official DOI from IEEE
  • On eventual rejection, a revised white-paper or preprint submitted elsewhere