Code Monkey home page Code Monkey logo

project-template's Introduction

Academic journal article template

Description

This is a markdown template for an academic article that is based on the code used to make the data sharing article published in the IEE special issue by White et al. (2013), and was cloned then altered from the github repo for that article. My goal here is to avoid having to go back and forth between R, MS Word, and some reference management utility to create an article. The main body is written in markdown format, which is then converted to whatever format you want (currently .pdf and .doc) using pandoc.

With this setup, any changes to the R file propagate to figures and results tables, and these changes are automatically incorporated in the final document (in pdf form). Tweaks can be made to export to other formats like LaTeX etc.

To make the article:

git clone git://github.com/mbjoseph/project-template.git
cd project-template
make

Citation formatting

The current citation format follows Ecology's guidelines, but more formats (covering most journals) are available on github:

git clone git://github.com/citation-style-language/styles.git

More info on citations and some other good information can be found on the scholarly markdown
wiki.

You'll need a .bib file that contains the BibTeX citation info for any articles that are cited. Most reference management software (e.g. Mendeley, Zotero, EndNote) can export a .bib file.

Disclaimer

This is my first crack at thinking about and setting up an efficient workflow. Most likely, there are better implementations out there, and this one is not quite perfect yet.

project-template's People

Contributors

mbjoseph avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.