Package 'linl'

Title: 'linl' is not 'Letter'
Description: A 'LaTeX' Letter class for 'rmarkdown', using the 'pandoc-letter' template adapted for use with 'markdown'.
Authors: Dirk Eddelbuettel and Aaron Wolen
Maintainer: Dirk Eddelbuettel <[email protected]>
License: GPL-3
Version: 0.0.5
Built: 2024-06-17 05:35:24 UTC
Source: https://github.com/eddelbuettel/linl

Help Index


LaTeX Letter format

Description

A format suitable for standard letters, along a with a number of helpful extensions

Usage

linl(..., keep_tex = FALSE)

Arguments

...

Additional arguments to rmarkdown::pdf_document

keep_tex

A boolean toggle to select whether intermediate LaTeX files are to be kept, defaults to FALSE

Value

R Markdown output format to pass to render

Letter features

Various aspects of the letter can be customized by setting the following variables in the document metadata:

address

Name and address of the recipient; takes a list for a multi-line address.

author

Writer of the letter; can take a list for a multi-line signature.

blockquote

Changes style of block quotations to match bootstrap (requires the mdframed package).

cc

Recipients to be carbon-copied; can take a list for multiple recipients.

closing

Text for the complementary close.

closing-indentation

Amount for closing signature block to be intended from left margin.

date

Custom date, and the current date will be automatically inserted if not specified.

encl

List of enclosures.

inline-links

Print links as standard inline hyperlinks rather than footnotes.

opening

Text for the salutation.

letterhead,letterfoot

Image file to be used as header or footer (requires the wallpaper package), applied only to the first page.

letterhead-side,letterfoot-side

Specifies which side of the page the header/footer is aligned to. Must be either L (left, the default) or R (right).

letterhead-scale,letterfoot-scale

Scale the header/footer to fraction of page width or height (depending on the file's aspect ratio).

letterhead-x-offset,letterhead-y-offset,letterfoot-x-offset,letterfoot-y-offset

How far the image must be placed away from the specified corner (0pt by default).

ps

Text to be added at the end of the letter as a postscript.

return-address

Address of the sender: takes a list to allow a multi-line address.

signature

Image file for a signature.

signature-before, signature-after, signature-scale

Allows adjustment of vertical space surrounding signature and the scaling of the signature image (1.0 being the default if unspecified).

The vignette source shows several of these options in use.

References

JJ Allaire, R Foundation, Hadley Wickham, Journal of Statistical Software, Yihui Xie, Ramnath Vaidyanathan, Association for Computing Machinery, Carl Boettiger, Elsevier, Karl Broman, Kirill Mueller, Bastiaan Quast, Randall Pruim, Ben Marwick, Charlotte Wickham, Oliver Keyes and Miao Yu (2017). rticles: Article Formats for R Markdown. R package version 0.4.1. https://CRAN.R-project.org/package=rticles

JJ Allaire, Joe Cheng, Yihui Xie, Jonathan McPherson, Winston Chang, Jeff Allen, Hadley Wickham, Aron Atkins, Rob Hyndman and Ruben Arslan (2017). rmarkdown: Dynamic Documents for R. R package version 1.6. https://CRAN.R-project.org/package=rmarkdown

Yihui Xie (2017). knitr: A General-Purpose Package for Dynamic Report Generation in R. R package version 1.17.

Aaron Wolen (2017). pandoc-letter. GitHub Repository. https://github.com/aaronwolen/pandoc-letter.

Examples

## Not run: 
rmarkdown::draft("MyLetter.Rmd", template = "pdf", package = "linl")
rmarkdown::render("MyLetter.Rmd")

## End(Not run)