| Type: | Package |
| Title: | 'pinp' is not 'PNAS' |
| Version: | 0.0.11 |
| Date: | 2024-12-08 |
| Description: | A 'PNAS'-alike style for 'rmarkdown', derived from the 'Proceedings of the National Academy of Sciences of the United States of America' ('PNAS') 'LaTeX' style, and adapted for use with 'markdown' and 'pandoc'. |
| URL: | https://github.com/eddelbuettel/pinp,http://dirk.eddelbuettel.com/code/pinp.html |
| BugReports: | https://github.com/eddelbuettel/pinp/issues |
| Imports: | rmarkdown, knitr |
| VignetteBuilder: | knitr |
| License: | GPL-3 |
| RoxygenNote: | 6.0.1 |
| NeedsCompilation: | no |
| Packaged: | 2024-12-08 21:01:42 UTC; edd |
| Author: | Dirk Eddelbuettel [aut, cre], James Joseph Balamuta [aut] |
| Maintainer: | Dirk Eddelbuettel <edd@debian.org> |
| Repository: | CRAN |
| Date/Publication: | 2024-12-08 21:10:02 UTC |
PNAS-alike two-column journal format.
Description
Format suitable for attractive two-column pdf vignettes
Usage
pinp(..., keep_tex = TRUE, citation_package = "natbib", collapse = FALSE)Arguments
... | Additional arguments to |
keep_tex | A boolean toggle to select whether intermediateLaTeX files are to be kept, defaults to |
citation_package | A character variable selecting the LaTeXcitation package; defaults to |
collapse | A boolean toggle to enable the |
Value
R Markdown output format to pass torender
Document options
Various aspects of pdf document can becustomized by setting either standardrmarkdown options,or any of the following options (which are shown inalphabetical order) in the document metadata:
abstract(Optional but recommended) A free-formatabstract summarizing the document.
acknowledgements(Optional) A free-format entrywhich will be placed at the end of the document.
address(Mandatory) YAML list with entries for
codeandaddress. The former matches theaffiliationfield of theauthorentry; the lettercan be a free-format text giving, say, department and universityalong with an email address.author(Mandatory) YAML list with entries for
nameandaffiliation. The latter is matched to thecodeentry inaddressoption.bibliography(Optional) Name of a
.bibfile,suffix can be omitted; defaut is no bibliography.doi(Optional but recommended) A free-format entrysuitable for a doi or url referencing the document or itsunderlying code.
fontsize(Optional) Documentfontsize, default is 9pt.
footer_contents(Optional) A free-format entry fortext placed in the footer, useful to associate with a package orvolume, default is ‘Package Vignette’.
date_subtitle(Optional) A free-form text stringwhich be used to mention the bibliographic info in a post-print.If not specified, defaults to "This version was compiled oncurrent date" where the current date is filled in.
document_date(Optional) A free-form text stringdesigned to specify the date of the document. It can be useful for exampleto specify the exact date of the publication in a post-print. If notspecified it defaults to the current date.
headercolor(Optional) Color code (in hexadecimalnotation) for the title and section headers, default is blue tonematching the R logo:
185FAF.keywords(Optional) Keywords describing thedocument, supplied as a list.
lead_author_surnames(Optional but recommended) Afree-format entry for a short author description placed in thefooter.
lineno(Optional) Logical value to selectline number display, may only work in one-column mode, default isfalse.
linkcolor(Optional) Color code (inhexadecimal notation) for the urls and reference links, defaultis a light blue tone from the PNAS style:
000065.numbersections(Optional) Logical value to selectnumbered section headers, default is false.
one_column(Optional) Logical value to selectone-column mode, default is false.
one_sided(Optional) Logical value to selectone-sided format, default is false.
output(Mandatory) Entry to tell
rmarkdownto render viapinp; must bepinp::pinp.secnumdepth(Optional) Level of (LaTeX) sectionlevels to number, default is 5.
skip_final_break(Optional) Logical value to skip afinal (force) page that is part of the PNAS style, default isfalse i.e. break is inserted as with PNAS.
title(Mandatory) document title, no default.
watermark(Optional) Logical value to select a‘Draft’ watermark to be added (though figures tend torender above it, default is false.
The vignette source shows several of these options in use, and alsodescribes some of the options.
References
JJ Allaire, R Foundation, Hadley Wickham, Journal of StatisticalSoftware, Yihui Xie, Ramnath Vaidyanathan, Association forComputing Machinery, Carl Boettiger, Elsevier, Karl Broman, KirillMueller, Bastiaan Quast, Randall Pruim, Ben Marwick, CharlotteWickham, Oliver Keyes and Miao Yu (2017). rticles: Article Formatsfor R Markdown. R package version 0.4.1.https://CRAN.R-project.org/package=rticles
JJ Allaire, Joe Cheng, Yihui Xie, Jonathan McPherson, WinstonChang, Jeff Allen, Hadley Wickham, Aron Atkins, Rob Hyndman andRuben Arslan (2017). rmarkdown: Dynamic Documents for R. R packageversion 1.6.https://CRAN.R-project.org/package=rmarkdown
Yihui Xie (2017). knitr: A General-Purpose Package for DynamicReport Generation in R. R package version 1.17.
See Also
pnas_article in packagerticles.
Examples
## Not run: rmarkdown::draft("MyArticle.Rmd", template = "pdf", package = "pinp")rmarkdown::render("MyArticle.Rmd")## End(Not run)