Code Monkey home page Code Monkey logo

pinp's Introduction

pinp Build Status Package-License CRAN Downloads

Pinp is not PNAS

Motivation

The template provided by the PNAS Article template in the rticles package makes it very easy and convenient to create attractive looking two-column papers with an option to switch to a one-column paper.

There were however a few changes we wanted to make such as the use of standard natbib citations, more extended use of color, a different font as well as the removal of a number of PNAS-specific title page items as well as general code and use simplification via a single LaTeX class file. So this pinp package started.

Example

Pinp Vignette

As of release 0.0.2, the package now has a vignette:

Rcpp Vignette

A complete pdf example of the two-column default template is provided here by the new introductory Rcpp vignette, which is itself based on our PeerJ Prepint.

A screenshot of the first two pages:

and the next two pages, showing a two-column figure

followed by pages five and six

and the final two pages:

Other Rcpp vignettes have been converted as well.

Status

The package is working and on CRAN.

Some float placements are a little fragile in LaTeX two-column mode. If in doubt, add more text around it to aid the heuristic.

Usage

Use the standard

install.packages("pinp")

to install it from CRAN, and then use as a Markdown template via RStudio, or use code such as

library(rmarkdown)
draft("mypaper.Rmd", template="pdf", package="pinp", edit=FALSE)
render("mypaper.Rmd")

to create a first draft of a new mypaper.Rmd.

Requirements

Beyond the R package dependencies, a working pandoc binary is needed. RStudio installs its own copy, otherwise do what is needed on your OS (i.e., something like sudo apt-get install pandoc pandoc-citeproc).

The pdf mode requires a fairly complete LaTeX installation, and has been used on Ubuntu and macOS. On Debian/Ubuntu, the following packages should provide a working set:

texlive-base
texlive-binaries
texlive-fonts-extra
texlive-fonts-recommended
texlive-generic-recommended
texlive-humanities
texlive-latex-base
texlive-latex-extra
texlive-latex-recommended
texlive-pictures
texlive-publishers
texlive-science

Authors

Dirk Eddelbuettel and James Balamuta, leaning on the earlier work by JJ et al in the rticles package.

The authors of the underlying PNAS LaTeX Style are not explicitedly listed, but PNAS refers to Overleaf.

License

GPL-3 for this package, as well as the short code taken with grateful acknowledgements from the rticles package.

The main PNAS LaTeX style file (and supporting files) are under the LPPL (LaTeX Project Public License) version 1.3 or later.

pinp's People

Contributors

coatless avatar eddelbuettel 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.