Skip to content

Commit

Permalink
tweak knit_child() documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yihui committed Jun 10, 2012
1 parent f2a60c9 commit 1c97488
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions R/output.R
Expand Up @@ -261,15 +261,15 @@ auto_out_name = function(input) {

#' Knit a child document
#'
#' This function is for LaTeX only except when it is used to extract R code from
#' the document; by default it knits a child document and returns the command to
#' input the result into the main document. It is designed to be used in the
#' inline R code and serves as the alternative to the \command{SweaveInput}
#' command in Sweave.
#' This function knits a child document and returns a character string to input
#' the result into the main document. It is designed to be used in the chunk
#' option \code{child} and serves as the alternative to the
#' \command{SweaveInput} command in Sweave.
#'
#' The LaTeX command used to input the child document (usually \samp{input} or
#' \samp{include}) is from the package option \code{child.command}
#' (\code{opts_knit$get('child.command')}).
#' For LaTeX output, the command used to input the child document (usually
#' \samp{input} or \samp{include}) is from the package option
#' \code{child.command} (\code{opts_knit$get('child.command')}). For other types
#' of output, the content of the compiled child document is returned.
#'
#' When we call \code{purl()} to extract R code, the code in the child document
#' is extracted and saved into an R script.
Expand Down

0 comments on commit 1c97488

Please sign in to comment.