userfriendlyscience (version 0.1-2)

rnwString: rnwString functions

Description

The rnwString functions make knitting PFDs a bit more userfriendly. The sanitizeLatexString function sanitizes a LaTeX string by escaping special characters. It is strongly based on the function described on http://stackoverflow.com/questions/5406071/r-sweave-latex-escape-variables-to-be-printed-in-latex by Aaron Rendahl.

Usage

rnwString.initiate(studyName, authorName,
                   docClassArgs = 'a4paper,portrait,11pt',
                   newPage = TRUE, pageMargins=15)
rnwString.terminate(rnwString) 
rnwString.generate(rnwString, rnwPath, fileName, pdfLatexPath,
                   envir = parent.frame())
sanitizeLatexString(str)
hasLaTeX(pdfLatexPath)

Arguments

studyName

The name of the study - used as the title of the PDF.

authorName

The name of the author(s) - also inserted on title page of the PDF.

docClassArgs

Default arguments for the document class in LaTeX. For example, to use landscape pages, this should be 'a4paper,landscape,11pt'.

newPage

Whether to end the initiation string with a newpage command. This can be set to false if you want to add more information on the first page(s).

pageMargins

Margin of the pages in millimeters.

rnwString

The rnwString to terminate or (after termination) generate.

rnwPath

The path where the temporary files (.rnw, .tex, etc) should be created. Use forward slashes. Note: the last character should not be a slash!

fileName

The filename to use for the temporary files. Omit the extension!

pdfLatexPath

The path to PdfLaTex. This file is part of a LaTeX installation that creates a pdf out of a .tex file. In Windows, you can download (portable) MikTex from http://miktex.org/portable. You then decide yourself where to install MikTex; pdflatex will end

envir

The environment where to evaluate the expressions (normally the environment where the function is called).

str

The character string to sanitize.

Value

• rnwString.initiate starts an rnwString; rnwString.terminate closes it; and rnwString.generate takes an rnwString and creates a pdf. sanitizeLatexString returns the sanitized string. hasLaTeX checks pdfLatexPath to make sure pdflatex or pdflatex.exe exists.

Examples

### sanitize a string
newString <- sanitizeLatexString('this is a tilde: ~.');
newString;
### newString is now: "this is a tilde: \\~."