R/tikzsetup.R

In bdemeshev/tikzsetup: tikzsetup-package: function to setup tikz device for Rmd/Rnw files

#' tikzsetup
#'
#' @name tikzsetup
#' @docType package
#' @author Boris Demeshev 
#' @import knitr tikzDevice
NULL

#' Setup tikz device for russian Rmd/Rnw files 
#'
#' Setup tikz device for russian Rmd/Rnw files 
#'
#' Setup tikz device for russian Rmd/Rnw files 
#'
#' @param lang the language
#' @param compiler currently pdftex and xelatex are supported
#' @param doc_class_options additional latex document class options 
#' @param message logical, should messages be activated, FALSE by default
#' @param warning logical, should warnings be activated, FALSE by default
#' @param setJustPlot logical, TRUE by default. Sometimes tikzsetup()
#' is called from a big-big document with a bunch of packages which may
#' interfere with tikzsetup(). In this one may use the value true/false
#' of JustPlot macro to load (or not load) some package.
#' @export
#' @return nothing
#' @examples
#' tikzsetup()
#' tikzsetup(lang="polish")
tikzsetup  <- function(compiler=c("pdftex","xetex","luatex"),lang="russian",
                        doc_class_options=NULL, 
                        message=FALSE, warning=FALSE,
                        setJustPlot = TRUE,
                        pt_size = 12) {

  Sys.setenv(LANG="EN") # Error message MUST be in english! CHECK
  Sys.setlocale("LC_TIME","C") # correct work of quantmod CHECK
  
  # http://stackoverflow.com/questions/15801683/knitr-and-tikzdevice-not-working-together-with-article-options
  
  message("One may conditionally load conflicting packages using the true/false value of JustPlot.")
  
  if(is.null(doc_class_options)) doc_class_options <- paste0(pt_size,"pt,a4paper")
    
  opts_chunk$set(dev='tikz', warning=warning, message=message, dev.args=list(pointsize=pt_size))
  
  compiler <- match.arg(compiler) # magic :)
  options(tikzDefaultEngine = compiler)
  
  options(tikzLatexPackages = c(
    # "\\usepackage{geometry}",
    "\\def\\JustPlot{true}",
    "\\usepackage{amsmath,amssymb,amsfonts}",
    "\\usepackage{tikz}",
    "\\usepackage[utf8]{inputenc}",
    "\\usetikzlibrary{calc}",
    paste0("\\usepackage[",lang,"]{babel}"),
    paste0("\\selectlanguage{",lang,"}"),
    "\\usepackage{standalone}"
  ))
  
  options(tikzXelatexPackages=c(
    "\\nonstopmode",
    "\\usepackage{tikz}",
    "\\usepackage[active,tightpage,xetex]{preview}",
    "\\PreviewEnvironment{pgfpicture}",
    "\\setlength\\PreviewBorder{0pt}"
  ))
  
  #options(tikzMetricsDictionary="/Users/boris/Documents/r_packages/") # speeds tikz up
  
  options(tikzDocumentDeclaration = 
            paste0("\\documentclass[",doc_class_options,"]{standalone}\n")) # book will not work
  
  options(tikzMetricPackages = c(
    "\\usepackage[utf8]{inputenc}",
    "\\usetikzlibrary{calc}",
    paste0("\\usepackage[",lang,"]{babel}"),
    paste0("\\selectlanguage{",lang,"}")
  ))
}