-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added README.md, two dot files, Rproj
- Loading branch information
1 parent
88bc3a4
commit b2fa6a2
Showing
4 changed files
with
90 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
^.*\.Rproj$ | ||
^\.Rproj\.user$ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
.Rproj.user | ||
.Rhistory | ||
.RData | ||
.Ruserdata |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
## linl [](https://travis-ci.org/eddelbuettel/linl) [](http://www.gnu.org/licenses/gpl-3.0.html) [](https://cran.r-project.org/package=linl) [](http://www.r-pkg.org/pkg/linl) | ||
|
||
Linl in not Letter | ||
|
||
### Motivation | ||
|
||
The LaTeX Letter class is very useful for simple letters. As such | ||
letters are also somewhat standardized, they make for excellent | ||
candidates for use by Markdown. | ||
|
||
This package leans on earlier work by [Aaron Woolen](http://aaronwolen.com/) in his | ||
[pandoc-letter](https://github.com/aaronwolen/pandoc-letter) repository, and extends it for use from | ||
R via the [rmarkdown](https://cran.r-project.org/package=rmarkdown) package. | ||
|
||
### Example | ||
|
||
#### Skeleton | ||
|
||
The skelecon creates a very simple letter. This shows the (complete) source on the left and the | ||
rendered pdf on the right: | ||
|
||
 | ||
|
||
#### Vignette | ||
|
||
The vignette example is a little more featureful and shows how to included a letterhead on-demand, | ||
as well as a signature. Both of these are driven by simple YAML headers as seen on the left: | ||
|
||
 | ||
|
||
### Status | ||
|
||
The package is working, but not yet on [CRAN](https://cran.r-project.org/). | ||
|
||
### Usage | ||
|
||
Use the standard | ||
|
||
```r | ||
install.packages("linl") | ||
``` | ||
|
||
to install it from CRAN, and then use as a Markdown template via RStudio, or use code such as | ||
|
||
```r | ||
library(rmarkdown) | ||
draft("myletter.Rmd", template="pdf", package="linl", edit=FALSE) | ||
render("myletter.Rmd") | ||
``` | ||
|
||
to create a first draft of a new `myletter.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 should only require a basic LaTeX installation. | ||
|
||
### Authors | ||
|
||
Dirk Eddelbuettel, leaning on the earlier work by Aaron Woolen. | ||
|
||
### License | ||
|
||
GPL-3 for this package, the work in [pandoc-letter](https://github.com/aaronwolen/pandoc-letter), | ||
as well as underlying Pandoc template. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
Version: 1.0 | ||
|
||
RestoreWorkspace: Default | ||
SaveWorkspace: Default | ||
AlwaysSaveHistory: Default | ||
|
||
EnableCodeIndexing: Yes | ||
UseSpacesForTab: Yes | ||
NumSpacesForTab: 4 | ||
Encoding: UTF-8 | ||
|
||
RnwWeave: Sweave | ||
LaTeX: pdfLaTeX | ||
|
||
BuildType: Package | ||
PackageInstallArgs: --no-multiarch --with-keep.source |