In pzhaonet/bookdownplus: Generate Assorted Books and Documents with R 'bookdown' Package

Introduction

The R package bookdownplus [@R-bookdownplus] is an extension of bookdown [@R-bookdown]. It is a collection of multiple templates on the basis of LaTeX, which are tailored so that I can work happily under the umbrella of bookdown. bookdownplus helps you write academic journal articles, guitar books, chemical equations, mails, calendars, and diaries.

Features

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.

With bookdownplus users can

• record guitar chords,

• write a mail in an elegant layout,

• write a laboratory journal, or a personal diary,

• draw a monthly or weekly or conference calendar,

• and, of course, write academic articles in your favourite way,

• with chemical molecular formulae and equations,

• even in Chinese,

• and more wonders will come soon.

Full documentation can be found in the book R bookdownplus Textbook. The webpage looks so-so, while the pdf file might give you a little surprise.

Quick start

Although this section might not be the latest version, the general idea won't change. Please see R bookdownplus Textbook to keep up with the update.

Preparation

Before starting, you have to install R, RStudio, 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.

Installation

install.package("bookdownplus")
# or
devtools::
  install_github("pzhaonet/bookdownplus")

Generate demo files

Run the following codes, and you will get some files (e.g. index.Rmd, body.Rmd, bookdownplus.Rproj) and folders in your working directory.

getwd() # this is your working directory. run setwd() to change it.
bookdownplus::bookdownplus()

Build a demo book

Now open bookdownplus.Rproj with RStudio, and press ctrl+shift+b to compile it. Your will get a book file named *.pdf in _book/folder.

Write your own

Write your own text in index.Rmd and body.Rmd, and build your own lovely book.

More outputs

By default, the book is in a pdf file. From 'bookdownplus' 1.0.3, users can get more output formats, including 'word', 'html' and 'epub'. Run:

bookdownplus::
  bookdownplus(template = 'article', 
               more_output = c('html', 'word', 'epub'))

Recommendations

I have been developing some other packages, which bring more features into 'bookdown', such as:

• mindr [@R-mindr], which can extract the outline of your book and turn it into a mind map, and

• pinyin [@R-pinyin], which can automatically generate '{#ID}' of the chapter headers even if there are Chinese characters in them.

Both of them have been released on CRAN and can be installed via:

install.packages('mindr')
install.packages('pinyin')

Enjoy your bookdowning!

Models

Eq. \@ref(eq:mc2) is an equation.

\begin{equation} E = mc^2 (#eq:mc2) \end{equation}

It can be written as $E = mc^2$.

Results

Fig. \@ref(fig:fig1) psum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

plot(cars)

Tab. \@ref(tab:tab1) psum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

knitr::kable(
  head(iris, 20), caption = 'Here is a nice table!',
  booktabs = TRUE
)

Conclusions

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum

pzhaonet/bookdownplus documentation built on Jan. 6, 2022, 7:45 a.m.