Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eddelbuettel/pinp

Pinp Is Not PNAS -- Two-Column PDF Template
https://github.com/eddelbuettel/pinp

cran markdown r-package vignette

Last synced: about 2 months ago
JSON representation

Pinp Is Not PNAS -- Two-Column PDF Template

Host: GitHub
URL: https://github.com/eddelbuettel/pinp
Owner: eddelbuettel
Created: 2017-09-02T19:13:34.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2024-05-18T13:21:31.000Z (4 months ago)
Last Synced: 2024-06-11T21:18:06.399Z (3 months ago)
Topics: cran, markdown, r-package, vignette
Language: TeX
Size: 5.9 MB
Stars: 146
Watchers: 14
Forks: 25
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog

Awesome Lists containing this project

README

        ## pinp: Pinp is not PNAS

[![CI](https://github.com/eddelbuettel/pinp/workflows/ci/badge.svg)](https://github.com/eddelbuettel/pinp/actions?query=workflow%3Aci)

[![Package-License](https://img.shields.io/badge/license-GPL--3-brightgreen.svg?style=flat)](https://www.gnu.org/licenses/gpl-3.0.html) 

[![CRAN](https://www.r-pkg.org/badges/version/pinp)](https://cran.r-project.org/package=pinp) 

[![Dependencies](https://tinyverse.netlify.app/badge/pinp)](https://cran.r-project.org/package=pinp) 

[![Downloads](https://cranlogs.r-pkg.org/badges/pinp?color=brightgreen)](https://www.r-pkg.org/pkg/pinp)

[![Last Commit](https://img.shields.io/github/last-commit/eddelbuettel/pinp)](https://github.com/eddelbuettel/pinp)

### Motivation

The template provided by the PNAS Article template in the

[rticles](https://cran.r-project.org/package=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:

![](https://eddelbuettel.github.io/pinp/pinp-vignette.png)

#### Rcpp Vignette

A complete pdf example of the two-column default template is

provided [here](https://eddelbuettel.github.io/pinp/Rcpp-introduction.pdf)

by the new introductory [Rcpp](https://dirk.eddelbuettel.com/code/rcpp.html) vignette, which is

itself based on our [PeerJ Prepint](https://peerj.com/preprints/3188/).

A screenshot of the first two pages:

![](https://eddelbuettel.github.io/pinp/Rcpp-introduction-p1+2.png)

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

![](https://eddelbuettel.github.io/pinp/Rcpp-introduction-p3+4.png)

followed by pages five and six

![](https://eddelbuettel.github.io/pinp/Rcpp-introduction-p5+6.png)

and the final two pages:

![](https://eddelbuettel.github.io/pinp/Rcpp-introduction-p7+8.png)

Other Rcpp vignettes have been converted as well.

### Status

The package is working as expected, and available via [CRAN](https://cran.r-project.org/).

### Usage 

Use the standard 

```r

install.packages("pinp")

```

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

```r

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

```

### See also

- [binb](https://github.com/eddelbuettel/binb): Binb is not Beamer: Stylish pdf Presentations from RMarkdown

- [linl](https://github.com/eddelbuettel/linl): Linl is not Letter: LaTeX letters from RMarkdown

- [tint](https://github.com/eddelbuettel/tint): tint is not tufte: Beautiful pdf or html handout or writeups

and the [minm](https://github.com/eddelbuettel/minm) package installing all of them.

### Authors

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

[rticles](https://cran.r-project.org/package=rticles) package.

The authors of the underlying [PNAS LaTeX Style](https://www.pnas.org/authors/submitting-your-manuscript) are

not explicitedly listed, but [PNAS](https://www.pnas.org) refers to

[Overleaf](https://www.overleaf.com/).

### License

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

[rticles](https://cran.r-project.org/package=rticles) package.

The main [PNAS LaTeX](https://www.pnas.org/authors/submitting-your-manuscript) style

file (and supporting files) are under the

[LPPL (LaTeX Project Public License) version 1.3 or later](https://www.latex-project.org/lppl/).