Package bookdownplus

Transcription

1 Version Date Package bookdownplus October 10, 2017 Title Generate Varied Types of Books and Documents with R 'bookdown' Package Author Peng Zhao Maintainer Peng Zhao <pzhao@pzhao.net> Depends R (>= 3.1.0) Imports knitr (>= 1.15), bookdown (>= ), yaml (>= ) Suggests A collection and selector of R 'bookdown' templates. 'bookdownplus' helps you write academic journal articles, guitar books, chemical equations, mails, calendars, and diaries. R 'bookdownplus' extends the features of 'bookdown', and simplifies the procedure. Users only have to choose a template, clarify the book title and author name, and then focus on writing the text. No need to struggle in 'YAML' and 'LaTeX'. License GPL URL BugReports RoxygenNote NeedsCompilation no Repository CRAN Date/Publication :59:04 UTC R topics documented: bookdownplus mail_bodysize mail_font mail_fontsize mail_style mail_theme

2 2 bookdownplus more_output poster_theme template Index 10 bookdownplus Create demo files for building books with R bookdown package. Technically, bookdownplus is a collection and selector of R bookdown templates. bookdownplus helps you write academic journal articles, guitar books, chemical equations, mails, calendars, and diaries. R bookdownplus extends the features of bookdown, and simplifies the procedure. Users only have to choose a template, clarify the book title and author name, and then focus on writing the text. No need to struggle in YAML and LaTeX. Full documentation of bookdownplus can be found in the book R bookdownplus Textbook. Here is a quick-start procedure. Before starting, you have to install bookdown package, and other software and packages (i.e. Pandoc, LaTeX, rmarkdown, rticle, knitr, etc.) which bookdown depends on. See the official manual of bookdown for details. Additionally, if you want to produce a poster, phython must be installed before using, and the path of phython might have to be added to the environmental variables for Windows users. Run bookdownplus() and specify the template with template argument, You will get some files (e.g. index.rmd, body.rmd, bookdownplus.rproj) and folders in your working directory. Although there are many other arguments for bookdownplus(), you can simply ignore them if you use bookdownplus package for the first time. Open bookdownplus.rproj with RStudio. Now press ctrl+shift+b to build it. Your will get a book file named *.pdf in _book/ folder. Write your own text in index.rmd and body.rmd, and build your own lovely book. bookdownplus(template = "thesis_classic", more_output = NULL, title = "R bookdownplus", author = "Peng Zhao", render = TRUE, rproj = TRUE, output_name = NA, mail_from_address = "15 Robin Hood Lane", mail_from_town = "11758 Massapequa, Long Island, New York", mail_from_phone = " ", mail_from_mobile = " ", mail_from_fax = " ", mail_from_ = "dapengde@live.com", mail_to_who = "recipient", mail_to_affiliation = "University of Innsbruck", mail_to_address = "recipient address", mail_to_town = " Beijing, China", mail_opening = "Dear Sir or Madam,", mail_closing = "Yours faithfully,", mail_date = "25 June, 2017", mail_style = c("casual", "classic", "oldstyle", "banking")[1], mail_theme = c("blue", "orange", "green", "red", "purple", "grey", "black")[1], mail_font = c("sffamily", "calligra ")[1], mail_fontsize = c("10pt", "11pt",

3 bookdownplus 3 "12pt")[3], mail_bodysize = c("tiny", "scriptsize", "footnotesize", "small", "normalsize", "large", "Large", "LARGE", "huge", "Huge")[5], poster_ = "pzhao@pzhao.net", poster_institute = "Institute of Ecology, Univ. Innsbruck", poster_longinstitute = "Institute of Ecology, University of Innsbruck, Austria", poster_web = "pzhao.org", poster_logo = "images/logo.png", poster_backimg = "images/logo.png", poster_bibliofiles = "bib/bib.bib", poster_theme = c("eco", "ocean", "rose")[1]) template more_output title author character. Choose a template for your book or doc. The default template is thesis_classic. Available templates are (run template() for hints): article, academic article, article_mdpi, academic article by mdpi, article_zh, academic article in Chinese, calendar, monthly or weekly calendar, chemistry, book with chemical molecular formulae and equations chemistry_zh, chemistry book in Chinese, discussion, article in discussion format, guitar, book with guitar chords, journal, laboratory journal or personal diary, mail, personal or business mail, nte_zh, a template from Nothing to envy, in Chinese poem, poem book, thesis_classic (default), classic thesis, thesis_mypku_zh, thesis of my Peking Uni., in Chinese, thesis_ubt, thesis of University of Bayreuth, thesis_zju_zh, thesis of Zhejiang Uni., in Chinese, yihui_demo, the original demo book by Yihui Xie, yihui_mini, a mini demo book by Yihui Xie, yihui_zh, the demo in Chinese by Yihui Xie, article2_zh, article in two columns in Chinese, not ready yet, poster, poster. optional output formats besides pdf_book, which can be (run more_output() for hints): NULL (default) word_document2 html_document2 epub_book gitbook character. book title. character. book author.

4 4 bookdownplus render rproj logical. whether to render automatically logical. whether to created an.rproj file automatically output_name chracter. the name of the output files. If NA (default), the template name will be used. mail_from_address character. sender s address (Street and No.) for mail template mail_from_town character. sender s town for mail template mail_from_phone character. sender s phone number for mail templae mail_from_mobile character. sender s mobile phone number for mail templae mail_from_fax character. sender s fax number for mail templae mail_from_ character. sender s for mail template mail_to_who character. recipient s name for mail template mail_to_affiliation character. recipient s affiliation (institute, university, etc.) for mail template mail_to_address character. recipient s address (Street and No.) for mail template mail_to_town character. recipient s town for mail template mail_opening character. opening of the mail, such as Dear Thomas, mail_closing character. closing of the mail, such as Yours, mail_date mail_style mail_theme mail_font character. The date appearing in the mail character. The mail style for mail template. Available styles are (run mail_style() for hints): casual (default), classic, oldstyle, and banking character. The mail theme for mail template. Available themes are (run mail_theme() for hints): blue (default), orange, green, red, purple, grey, and black character. The font of the body for mail template. Available fonts are (run mail_font() for hints): sffamily (default), or

5 bookdownplus 5 calligra mail_fontsize character. fontsize of the mail for mail template. Available sizes are (run mail_fontsize() for hints): mail_bodysize 10pt, 11pt, and 12pt (default) character. fontsize of the mail body for mail template. Available sizes are (run mail_bodysize() for hints): tiny, scriptsize, footnotesize, small, normalsize (default), large, Large, LARGE, huge, Huge. poster_ character. author s for poster template poster_institute character. for poster template poster_longinstitute character. for poster template poster_web poster_logo character. for poster template character. The path of the logo image. for poster template poster_backimg character. The path of the background image. for poster template poster_bibliofiles character. The path of the bib file for poster template poster_theme character. theme for poster template. available themes are eco (default), ocean, rose, night, ice. demo files to build with bookdown bookdownplus(render = FALSE) bookdownplus(template = "article", render = FALSE)

6 6 mail_font mail_bodysize Available fontsize for mail body Available fontsize for mail body mail_bodysize( = FALSE) a vector or a. mail_bodysize() mail_font Available fonts for mail body Available fonts for mail body mail_font( = FALSE) a vector or a. mail_font()

7 mail_fontsize 7 mail_fontsize Available fontsize for mail template Available fontsize for mail template mail_fontsize( = FALSE) a vector or a. mail_fontsize() mail_style Available styles for mail template Available styles for mail template mail_style( = FALSE) a vector or a. mail_style()

8 8 more_output mail_theme Available themes for mail template Available themes for mail template mail_theme( = FALSE) a vector or a. mail_theme() more_output Available output formats besides pdf_book Available output formats besides pdf_book more_output( = FALSE) a vector or a. more_output()

9 poster_theme 9 poster_theme Available themes for poster templat body Available themes for poster templat body poster_theme( = FALSE) a vector or a. poster_theme() template Available templates Available templates template( = FALSE) a vector or a displaying available templates. template()

10 Index bookdownplus, 2 mail_bodysize, 6 mail_font, 6 mail_fontsize, 7 mail_style, 7 mail_theme, 8 more_output, 8 poster_theme, 9 template, 9 10