Skip to content

Commit

Permalink
Add ProjectTemplate reference in man page
Browse files Browse the repository at this point in the history
  • Loading branch information
juba committed Aug 26, 2016
1 parent 1baaa1e commit 64f2ab5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
7 changes: 4 additions & 3 deletions R/create.doc.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@
#'
#' @param dirname name of the directory to create
#' @param format R Markdown format to use
#' @param report indicates if the new document is living in the \code{report}
#' @param report indicates if the new document is living in the \code{report} directory
#' (for ProjectTemplate projects)
#' @param makefile indicates if a `Makefile` for HTML and PDF rendering should
#' be created in the document folder
#' @details
#' For now on, the available formats are "html_clean", "html_docco".
#'
#' If \code{report} is TRUE, then a small snippet of code is added at the
#' beginning of the Rmd file. This code allows to switch to the project root
#' before running \code{load.project} when using the included Makefile.
#' beginning of the Rmd file. This code allows to switch to the ProjectTemplate
#' project root before running \code{load.project} when using the included Makefile.
#' @return
#' No value is returned.
#' @author Julien Barnier <julien.barnier@@ens-lyon.fr>
Expand Down
7 changes: 4 additions & 3 deletions man/create.doc.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 64f2ab5

Please sign in to comment.