R/tangle_lyx.R

In SciViews/svSweave: 'SciViews' - 'Sweave', 'Knitr' and R Markdown Companion Functions

#' @export
#' @rdname clean_lyx
tangle_lyx <- function(file, driver = Rtangle(),
syntax = getOption("SweaveSyntax"), encoding = "UTF-8", width = 80,
useFancyQuotes = TRUE, annotate = TRUE, logFile = file.path(tempdir(),
".lyxSweave.log"), ...) {

  # Run in LyX as the Sweave -> R converter:
  #> R -e svSweave::tangle_lyx(\"$$i\",log=\"/tmp/.lyxSweave.log\"[,annotate=FALSE]) -q --vanilla

  # Switch encoding (we do work with UTF-8 by default)
  oenc <- options(encoding = encoding)
  on.exit(options(oenc))
  Sys.setlocale("LC_CTYPE", "UTF-8")

  # By default, use fancy quotes
  ofc <- options(useFancyQuotes = useFancyQuotes)
  on.exit(options(ofc), add = TRUE)

  # Set default width for text to a reasonable value
  owidth <- options(width = width)
  on.exit(options(owidth), add = TRUE)

  # Issue warnings immediately
  owarn <- options(warn = 1)
  on.exit(options(owarn), add = TRUE)

  # Process 'file'
  if (!file.exists(file)) {
    stop("You must provide the name of an existing .Rnw file to process!")
  } else {
    # Redirect output
    unlink(logFile)
    on.exit({
      sink(type = "message")
      sink()
      # Echo results
      try(cat(readLines(logFile), sep = "\n"), silent = TRUE)
    }, add = TRUE)
    con <- file(logFile, open = "wt")
    sink(con)
    sink(con, type = "message")
    cat("Tangling ", basename(file), " ...\n", sep = "")

    # Clean the R noweb file
    opts <- cleanLyxRnw(file, encoding = encoding)

    # Tangle or Purl the file
    if (!is.list(opts) || !length(opts$kind))
      stop("no Sweave kind defined (must be Sweave or Knitr)")
    cat("Processing the document using ", opts$kind, "\n", sep = "")
    switch(opts$kind,
      Sweave = Stangle(file, driver = driver, syntax = syntax,
        annotate = annotate, ...),
      Knitr = purl(file, ...),
      stop("Wrong kind of Sweave document: '", opts$kind, "'")
    )
  }
}

# Backward compatibility

#' @export
#' @rdname clean_lyx
tangleLyxRnw <- tangle_lyx

#' @export
#' @rdname clean_lyx
purl_lyx <- function(file, encoding = "UTF-8", width = 80,
useFancyQuotes = TRUE, logFile = file.path(tempdir(), ".lyxSweave.log"), ...) {

  # Run in LyX as the Sweave -> R converter:
  #> R -e svSweave::purl_lyx(\"$$i\",log=\"/tmp/.lyxSweave.log\"[,annotate=FALSE]) -q --vanilla

  # Switch encoding (we do work with UTF-8 by default)
  oenc <- options(encoding = encoding)
  on.exit(options(oenc))
  Sys.setlocale("LC_CTYPE", "UTF-8")

  # By default, use fancy quotes
  ofc <- options(useFancyQuotes = useFancyQuotes)
  on.exit(options(ofc), add = TRUE)

  # Set default width for text to a reasonable value
  owidth <- options(width = width)
  on.exit(options(owidth), add = TRUE)

  # Issue warnings immediately
  owarn <- options(warn = 1)
  on.exit(options(owarn), add = TRUE)

  # Process 'file'
  if (!file.exists(file)) {
    stop("You must provide the name of an existing .Rnw file to process!")
  } else {
    # Redirect output
    unlink(logFile)
    on.exit({
      sink(type = "message")
      sink()
      # Echo results
      try(cat(readLines(logFile), sep = "\n"), silent = TRUE)
    }, add = TRUE)
    con <- file(logFile, open = "wt")
    sink(con)
    sink(con, type = "message")
    cat("Tangling ", basename(file), " using knitr...\n", sep = "")

    # Clean the R noweb file
    cleanLyxRnw(file, encoding = encoding)

    # Tangle (purl) the file
    purl(file, ...)
  }
}

# Backward compatibility

#' @export
#' @rdname clean_lyx
purlLyxRnw <- purl_lyx