Skip to content

Commit

Permalink
fix:
Browse files Browse the repository at this point in the history
exporting now build_current_book_part
+ help
generate_book help update
  • Loading branch information
plecharpent committed Oct 15, 2020
1 parent 9e29e76 commit c60459d
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 4 deletions.
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Generated by roxygen2: do not edit by hand

export(build_current_book_part)
export(find_stics_names)
export(gen_bibtex_file)
export(generate_book)
Expand Down
27 changes: 25 additions & 2 deletions R/generate_book.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
#'
#' @param input_rmd Chapter Rmd file name (optional)
#' @param book_pkg_dir Book package directory path (optional, default: current directory)
#' @param output_format String defining the type of document to build
#' (optional, default: "bookdown::html_document2")
#' @param output_format String defining the type of document to build (optional);
#' among "bookdown::pdf_document2", "bookdown::pdf_document2",
#' "bookdown::gitbook" (default)
#' @param params A list containing parameters to pass to the Rmd
#' document to parameterize the output or overload existing params in the
#' document
Expand All @@ -16,6 +17,8 @@
#' @return A success status of the document generation
#' @export
#'
#' @seealso \code{\link{build_current_book_part}}
#'
#' @examples
#' \dontrun{
#' generate_book()
Expand Down Expand Up @@ -123,6 +126,26 @@ build_book_part <- function( file_name = NULL, other_names = c("index", "Appendi
}


#' Generating a 'bookdown::gitbook' document from the current
#' edited bookdown chapter (Rmd)
#'
#' @description Generating an output document from the open Rmd file
#' in the RStudio editor without specifying neither the file name nor
#' the output format ('bookdown::gitbook')
#'
#' @seealso \code{\link{generate_book}} for specifying Rmd files list, and output
#' format
#'
# @return
#' @export
#'
#' @examples
#' \dontrun{
#'
#' build_current_book_part()
#'
#' }
#'
build_current_book_part <- function() {
build_book_part()
}
26 changes: 26 additions & 0 deletions man/build_current_book_part.Rd

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

8 changes: 6 additions & 2 deletions man/generate_book.Rd

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

0 comments on commit c60459d

Please sign in to comment.