#' A wrapper for rst2pdf

#'

#' Convert reST to PDF using \command{rst2pdf} (which converts from rst to PDF

#' using the ReportLab open-source library).

#' @param input The input rst file.

#' @param command Character string giving the path of the

#'   \command{rst2pdf} program. If the program is not in your PATH, the full path has to be

#'   given here.

#' @param options Extra command line options, e.g. \code{'-v'}.

#' @author Alex Zvoleff and Yihui Xie

#' @return An input file \file{*.rst} will produce \file{*.pdf} and this output

#'   filename is returned if the conversion was successful.

#' @export

#' @seealso \code{\link{knit2pdf}}

#' @references \url{https://github.com/rst2pdf/rst2pdf}

rst2pdf = function(input, command = 'rst2pdf', options = '') {

}

#' Convert various input files to various output files using \code{knit()} and

#' Pandoc

#'

#' Knits the input file and compiles to an output format using Pandoc.

#' @inheritParams knit

#' @param to Character string giving the Pandoc output format to use.

#' @param pandoc_wrapper An R function used to call Pandoc. If \code{NULL} (the

#'   default), \code{rmarkdown::\link[rmarkdown]{pandoc_convert}()} will be used

#'   if \pkg{rmarkdown} is installed, otherwise \code{\link{pandoc}()}.

#' @param ... Options to be passed to the \code{pandoc_wrapper} function.

#' @param encoding Ignored (always assumes UTF-8).

#' @author Trevor L. Davis

#' @return Returns the output of the \code{pandoc_wrapper} function.

#' @export

knit2pandoc = function(

  input, output = NULL, tangle = FALSE, text = NULL, quiet = FALSE,

  envir = parent.frame(), to = 'html', pandoc_wrapper = NULL, ..., encoding = 'UTF-8'

) {

}

#' Convert Rnw or Rrst files to PDF

#'

#' Knit the input Rnw or Rrst document, and compile to PDF using

#' \code{tinytex::\link[tinytex]{latexmk}()} or \code{\link{rst2pdf}()}.

#' @inheritParams knit

#' @param compiler A character string giving the LaTeX engine used to compile

#'   the tex document to PDF. For an Rrst file, setting \code{compiler} to

#'   \code{'rst2pdf'} will use \code{\link{rst2pdf}} to compile the rst file to

#'   PDF using the ReportLab open-source library.

#' @param ... Options to be passed to \code{tinytex::\link[tinytex]{latexmk}()}

#'   or \code{\link{rst2pdf}()}.

#' @author Ramnath Vaidyanathan, Alex Zvoleff and Yihui Xie

#' @return The filename of the PDF file.

#' @note The \code{output} argument specifies the output filename to be passed

#'   to the PDF compiler (e.g. a tex document) instead of the PDF filename.

#' @export

#' @examples #' compile with xelatex

#' ## knit2pdf(..., compiler = 'xelatex')

#'

#' #' compile a reST file with rst2pdf

#' ## knit2pdf(..., compiler = 'rst2pdf')

knit2pdf = function(

  input, output = NULL, compiler = NULL, envir = parent.frame(), quiet = FALSE, ...

) {

  }

  } else {

  }

}

#' Convert markdown to HTML using knit() and markdownToHTML()

#'

#' This is a convenience function to knit the input markdown source and call

#' \code{markdown::\link{markdownToHTML}()} in the \pkg{markdown} package to

#' convert the result to HTML.

#' @inheritParams knit

#' @param ... Options passed to \code{markdown::\link{markdownToHTML}()}.

#' @param force_v1 Boolean; whether to force rendering the input document as an

#'   R Markdown v1 document, even if it is for v2.

#' @export

#' @seealso \code{\link{knit}}, \code{markdown::\link{markdownToHTML}}

#' @return If the argument \code{text} is NULL, a character string (HTML code)

#'   is returned; otherwise the result is written into a file and the filename

#'   is returned.

#' @note The \pkg{markdown} package is for R Markdown v1, which is much less

#'   powerful than R Markdown v2, i.e. the \pkg{rmarkdown} package

#'   (\url{https://rmarkdown.rstudio.com}). To render R Markdown v2 documents to

#'   HTML, please use \code{rmarkdown::render()} instead.

#' @examples # a minimal example

#' writeLines(c("# hello markdown", '```{r hello-random, echo=TRUE}', 'rnorm(5)', '```'), 'test.Rmd')

#' knit2html('test.Rmd')

#' if (interactive()) browseURL('test.html')

#'

#' unlink(c('test.Rmd', 'test.html', 'test.md'))

knit2html = function(input, output = NULL, ..., envir = parent.frame(), text = NULL,

                     quiet = FALSE, encoding = 'UTF-8', force_v1 = FALSE) {

  # packages containing vignettes using R Markdown v1 should declare dependency

  # on 'markdown' in DESCRIPTION (typically in Suggests)

      )

    }

  }

  # TODO: remove the above hack in the future when no CRAN packages have the issue

    )

  }

}

#' Knit an R Markdown document and post it to WordPress

#'

#' This function is a wrapper around the \pkg{RWordPress} package. It compiles

#' an R Markdown document to HTML and post the results to WordPress. Please note

#' that \pkg{RWordPress} has not been updated for several years, which is

#' \href{https://github.com/yihui/knitr/issues/1866}{not a good sign}. For

#' blogging with R, you may want to try the \pkg{blogdown} package instead.

#' @param input Filename of the Rmd document.

#' @param title Title of the post.

#' @param ... Other meta information of the post, e.g. \code{categories = c('R',

#'   'Stats')} and \code{mt_keywords = c('knitr', 'wordpress')}, et cetera.

#' @param shortcode A length-2 logical vector: whether to use the shortcode

#'   \samp{[sourcecode lang='lang']}, which can be useful to WordPress.com users

#'   for syntax highlighting of source code and output. The first element

#'   applies to source code, and the second applies to text output. By default,

#'   both are \code{FALSE}.

#' @param action Whether to create a new post, update an existing post, or

#'   create a new page.

#' @param postid If \code{action} is \code{editPost}, the post id \code{postid}

#'   must be specified.

#' @param publish Boolean: publish the post immediately?

#' @inheritParams knit

#' @export

#' @references \url{https://yihui.org/knitr/demo/wordpress/}

#' @author William K. Morris, Yihui Xie, and Jared Lander

#' @note This function will convert the encoding of the post and the title to

#'   UTF-8 internally. If you have additional data to send to WordPress (e.g.

#'   keywords and categories), you may have to manually convert them to the

#'   UTF-8 encoding with the \code{\link{iconv}(x, to = 'UTF-8')} function

#'   (especially when using Windows).

#' @examples # see the reference

knit2wp = function(

  input, title = 'A post from knitr', ..., envir = parent.frame(), shortcode = FALSE,

  action = c('newPost', 'editPost', 'newPage'), postid, publish = TRUE

) {

  )

  )

  )

  # figure out if we are making a newPost or overwriting an existing post

  # build a list of arguments to be fed into either newPost or editPost

  # the first argument is the content, which itself is a list containing

  #     description

  #     title

  #     ...

  # then there is the publish argument

  # if we are editing the post, also include the argument for postid

}

#' Watch an input file continuously and knit it when it is updated

#'

#' Check the modification time of an input file continously in an infinite loop.

#' Whenever the time indicates the file has been modified, call a function to

#' recompile the input file.

#'

#' This is actually a general function not necessarily restricted to

#' applications in \pkg{knitr}. You may specify any \code{compile} function to

#' process the \code{input} file. To stop the infinite loop, press the

#' \samp{Escape} key or \samp{Ctrl + C} (depending on your editing environment

#' and operating system).

#' @param input An input file path, or a character vector of mutiple input file paths.

#' @param compile A function to compile the \code{input} file. This could be e.g.

#'   \code{\link{knit}} or \code{\link{knit2pdf}}, depending on the input file

#'   and the output you want.

#' @param interval A time interval to pause in each cycle of the infinite loop.

#' @param ... Other arguments to be passed to the \code{compile} function.

#' @export

#' @examples # knit_watch('foo.Rnw', knit2pdf)

#'

#' # knit_watch('foo.Rmd', rmarkdown::render)

knit_watch = function(input, compile = knit, interval = 1, ...) {

  }

  }

}