Skip to content

Author instructions

Pjotr Prins edited this page Mar 31, 2020 · 2 revisions

In the pre-print process we should emphasize the structure of a (pre-publishable) subdocument. The structure can be:

Project title

Authors with ORCIDs(!)

(the first author is the point person for the mini-publication, unless explicitly specified)

  1. State the problem you worked on
  2. Give the state-of-the art/plan
  3. Describe what you have done/results starting with The working group created...
  4. Write a conclusion
  5. Write up any future work

We suggest to use either github markdown (wiki or a README.md) or the https://osf.io/ wiki pages which you can create when you open an account with ORCID. HackMD is another option. Make sure we can find this information by adding a group page on the wiki of this biohackathon.

In addition provide a figure with caption (if applicable) and Also provide a URL to your Jupyter notebook and/or github repo and data (as research objects)

When every project sticks to this layout the reader knows what to expect when reading about every project. This is about the reader experience rather than the author experience! So please stick with this 'flow'.

Example:

Making the Sequence Read Archive public and searchable

(State the problem) Information from next-generation sequencing experiments is separately archived to different databases including: the Sequence Read Archive (SRA) (Leinonen et al., 2010), the National Center for Biotechnology Information’s (NCBI) BioProject (Barrett et al., 2011), and BioSample (Courtot et al., 2018). (State of the art/plan) The working group aimed to make information in the SRA public and searchable (Figure 7). (Work executed) The following tasks were accomplished during the BH17: 1) customized the system to follow DNA Databank of Japan (DDBJ) (Stoesser, 2004) requests; 2) defined specifications for a brand new Database Center for Life Science (DBCLS) SRA (Leinonen et al., 2010)) Web user interface; 3) converted BioProject and BioSample data to RDF; and 4) developed a prototype method for searching reads by expression pattern. (Future work) In the future, the working group will integrate the SRA with BioProject and BioSample metadata as well as develop a Web user interface.

(figure and references)

Aboved is a very short example. There is no limit to the size. See below mini-publication for a more elaborate example.

Make sure references are added in the bibtex format. Example of a paper and bib file with generated PDF output can be found here.