Skip to content

awillats/markdown-manuscript-template

Repository files navigation

markdown-manuscript-template

basic structure for a planning, writing, sharing a scientific manuscript and related code


🚧 DOI badge goes here 🚧

Manuscript for @import "_meta/title.md" @import "_meta/authors.md"

pre-print: https://www.bioarxiv.org paper is published and available at journal.com

Abstract: Lorem Ipsum

Repo Organization

  • outline.md - outline, overview of the manuscript
  • manuscript_v1.md - full document for compiling into pdf
    • imports sections of text
  • writing_sections/ - text for the manuscript split into chapters
  • figures/ - output files for figures
  • publish/ - compiled pdfs, html files
  • bib/ - bibliography files
  • data/ - raw data sources
  • code/ - code required to perform analysis, generate figures
    • ( consider saving pre-trained models, additional documentation also )
  • _planning/ - to-do list for work in progress items
    • can remove from final main branch
  • _archive/
    • can remove from final main branch

Main plots

  • Figure 1
  • Figure 2

Data sources

source description
the moon a list of rock diameters
the earth a list of rock weights

Code

Associated code is present in the following repositories

Prerequisites

You may need to install the following dependencies

Install

Supplemental plots

  • Figure S1
  • Figure S2

Contact info

submit issues (here), email (person@email.com) for questions

License

(license name here)

About

basic structure for a planning, writing, sharing a scientific manuscript and related code

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published