bookdown

Authoring Books and Technical Documents with R Markdown

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
8 of 113 committers (7.1%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (18.3%) to scientific vocabulary

Keywords

book bookdown epub gitbook html latex rmarkdown

Keywords from Contributors

pandoc literate-programming package-creation tidy-data ropensci travis-ci tidyverse network-graph visualisation exploratory-data-analysis

Last synced: 6 months ago · JSON representation

Repository

Authoring Books and Technical Documents with R Markdown

Basic Info

Host: GitHub
Owner: rstudio
License: gpl-3.0
Language: JavaScript
Default Branch: main
Homepage: https://pkgs.rstudio.com/bookdown/
Size: 17.8 MB

Statistics

Stars: 3,951
Watchers: 126
Forks: 1,273
Open Issues: 228
Releases: 43

Topics

book bookdown epub gitbook html latex rmarkdown

Created over 10 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct

bookdown

A open-source (GPL-3) R package to facilitate writing books and long-form articles/reports with R Markdown. Features include:

Generate printer-ready books and ebooks from R Markdown documents
A markup language easier to learn than LaTeX, and to write elements such as section headers, lists, quotes, figures, tables, and citations
Multiple choices of output formats: PDF, LaTeX, HTML, EPUB, and Word.
Possibility of including dynamic graphics and interactive applications (HTML widgets and Shiny apps)
Support for languages other than R, including C/C++, Python, and SQL, etc.
LaTeX equations, theorems, and proofs work for all output formats
Can be published to GitHub, bookdown.org, and any web servers
Integrated with the RStudio IDE
One-click publishing to https://bookdown.org

Book

Installation

You can install the package from CRAN as follows:

r install.packages("bookdown")

If you want to use the development version of the bookdown package, you can install the package from GitHub via the pak package:

``` r

install.packages("pak")

pak::pak('rstudio/bookdown') ```

Usage

The easiest way to start a new Bookdown project is from within RStudio IDE. Go to File > New Project > New Directory > Book project using bookdown.

This will create a new directory with an example book as template. You can build the HTML version of this example book without doing any modification:

Go into the Build Pane in the RStudio IDE
Click on Build Book > bookdown::gitbook

You can also run bookdown::render_book() in the R console.

Learn more about using bookdown in the Getting started section.

Getting help

There are two main places to get help:

The RStudio community is a friendly place to ask any questions about bookdown. Be sure to use the bookdown tag.
Stack Overflow is a great source of answers to common bookdown questions. Use the tags [r][bookdown] if you ask a question.

Code of Conduct

Please note that the bookdown project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Owner

Name: RStudio
Login: rstudio
Kind: organization
Email: info@rstudio.org
Location: Boston, MA

Website: http://rstudio.org
Repositories: 356
Profile: https://github.com/rstudio

GitHub Events

Total

Create event: 3
Issues event: 29
Release event: 2
Watch event: 202
Delete event: 1
Issue comment event: 131
Push event: 14
Pull request review comment event: 13
Pull request review event: 21
Pull request event: 13
Fork event: 27

Last Year

Create event: 3
Issues event: 29
Release event: 2
Watch event: 202
Delete event: 1
Issue comment event: 131
Push event: 14
Pull request review comment event: 13
Pull request review event: 21
Pull request event: 13
Fork event: 27

Committers

Last synced: 9 months ago

All Time

Total Commits: 1,825
Total Committers: 113
Avg Commits per committer: 16.15
Development Distribution Score (DDS): 0.223

Past Year

Commits: 24
Committers: 6
Avg Commits per committer: 4.0
Development Distribution Score (DDS): 0.417

Top Committers

Name	Email	Commits
Yihui Xie	x**e@y**e	1,418
Christophe Dervieux	c**x@g**m	176
JJ Allaire	jj@r****g	51
Maëlle Salmon	m**n@y**e	12
Hadley Wickham	h**m@g**m	9
atusy	3****y	8
Kevin Cheung	m**n@g**m	7
Alison Presmanes Hill	a**n@r**m	7
Joseph Bayly	j**y@g**m	4
jooyoungseo	s**y@g**m	4
shirdekel	4****l	3
Thierry Onkelinx	T****O	3
Joyce Robbins	j****3	3
Dean Attali	d**i@g**m	3
Clifton Franklund	f**c@f**u	3
Salim B	s**m@p**e	3
Brock	k**k@a**e	3
Kirill Müller	k****r	2
Nick	t****s	2
Pedro Rafael	p**o@g**m	2
Ralf Stubner	r**r@g**m	2
adamvi	a**n@g**m	2
Ellis Valentiner	e****r	2
David Shuman	d**1@m**u	2
Romain LESUR	R****r	2
Hao Zhu	h**3@g**m	2
F. Shen	f**n@g**m	2
jennybc	j**y@s**a	2
Zhuoer Dong	d**r@m**n	2
Carson Sievert	c**1@g**m	1
and 83 more...

Committer Domains (Top 20 + Academic)

rstudio.com: 3 yihui.name: 1 rstudio.org: 1 ferris.edu: 1 posteo.de: 1 ab.mpg.de: 1 macalester.edu: 1 stat.ubc.ca: 1 mail.nankai.edu.cn: 1 pa.gov: 1 uni-koeln.de: 1 lcano.com: 1 unl.edu: 1 itconcepts.net: 1 yahoo.de: 1 deininger.net: 1 student.cumtb.edu.cn: 1 scipi.net: 1 126.com: 1 cos.name: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 144
Total pull requests: 61
Average time to close issues: 6 months
Average time to close pull requests: 2 months
Total issue authors: 117
Total pull request authors: 28
Average comments per issue: 4.41
Average comments per pull request: 1.89
Merged pull requests: 37
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 19
Pull requests: 15
Average time to close issues: 1 day
Average time to close pull requests: 9 days
Issue authors: 17
Pull request authors: 5
Average comments per issue: 0.68
Average comments per pull request: 2.67
Merged pull requests: 11
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

cderv (14)
piiskop (6)
N0rbert (3)
jtbayly (3)
kylelundstedt (2)
karlmay88 (2)
wangzhen89 (2)
shivam7898 (2)
moondog1969 (2)
wjakethompson (1)
sonv (1)
herryATcsiro (1)
dmklotz (1)
timwaite (1)
LaureTomas (1)

Pull Request Authors

cderv (15)
katrinabrock (6)
hayden-MB (4)
hadley (3)
ElenaMetori (2)
lcougnaud (2)
atusy (2)
chadyuu (2)
deining (2)
yihui (2)
cgrandin (2)
apreshill (2)
bwu62 (2)
ThierryO (1)
dmurdoch (1)

Top Labels

Issue Labels

feature (26) bug (21) question (19) next (7) help wanted :heart: (6) bs4_book :hiking_boot: (5) pandoc (3) reprex (2) RStudio IDE (2) tinytex (1) theme: mobile friendly (1) knitr (1) documentation (1) duplicate (1)

Pull Request Labels

book (2) documentation (2) next (2) feature (1)

Packages

Total packages: 2
Total downloads:
- cran 49,268 last-month
Total docker downloads: 2,462,268

Total dependent packages: 187
(may contain duplicates)
Total dependent repositories: 1,897
(may contain duplicates)
Total versions: 69
Total maintainers: 1

cran.r-project.org: bookdown

Authoring Books and Technical Documents with R Markdown

Homepage: https://github.com/rstudio/bookdown
Documentation: http://cran.r-project.org/web/packages/bookdown/bookdown.pdf
License: GPL-3
Latest release: 0.44
published 6 months ago

Versions: 44
Dependent Packages: 178
Dependent Repositories: 1,887
Downloads: 49,268 Last month
Docker Downloads: 2,462,268

Rankings

Stargazers count: 0.0%

Forks count: 0.0%

Dependent repos count: 0.2%

Dependent packages count: 0.6%

Downloads: 1.8%

Average: 3.3%

Docker downloads count: 17.3%

Maintainers (1)

xie@yihui.name

Last synced: 6 months ago

conda-forge.org: r-bookdown

Homepage: https://github.com/rstudio/bookdown
License: GPL-3.0-only
Latest release: 0.30
published over 3 years ago

Versions: 25
Dependent Packages: 9
Dependent Repositories: 10

Rankings

Forks count: 4.3%

Dependent packages count: 6.5%

Stargazers count: 7.0%

Average: 7.2%

Dependent repos count: 11.1%

Last synced: 6 months ago

Dependencies

.github/workflows/Book.yaml actions

JamesIves/github-pages-deploy-action 4.1.5 composite
actions/cache v2 composite
actions/checkout v2 composite
actions/upload-artifact main composite
cderv/actions/setup-pandoc-nightly nightly-pandoc composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite
r-lib/actions/setup-tinytex v2 composite

.github/workflows/R-CMD-check.yaml actions

actions/checkout v2 composite
cderv/actions/setup-pandoc-nightly nightly-pandoc composite
r-lib/actions/check-r-package v2 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite
r-lib/actions/setup-tinytex v2 composite

.github/workflows/lock.yml actions

dessant/lock-threads v2.0.1 composite

.github/workflows/pkgdown.yaml actions

actions/cache v2 composite
actions/checkout v2 composite
nwtgck/actions-netlify v1.1 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

DESCRIPTION cran

R >= 3.5.0 depends
htmltools >= 0.3.6 imports
jquerylib * imports
knitr >= 1.38 imports
rmarkdown >= 2.14 imports
tinytex >= 0.12 imports
xfun >= 0.29 imports
yaml >= 2.1.19 imports
bslib >= 0.2.4 suggests
downlit >= 0.4.0 suggests
htmlwidgets * suggests
jsonlite * suggests
miniUI * suggests
rsconnect >= 0.4.3 suggests
rstudioapi * suggests
servr >= 0.13 suggests
shiny * suggests
testit >= 0.9 suggests
testthat >= 3.1.0 suggests
tibble * suggests
tufte * suggests
webshot * suggests
withr >= 2.3.0 suggests
xml2 * suggests

bookdown

Science Score: 36.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

bookdown

Book

Installation

install.packages("pak")

Usage

Getting help

Code of Conduct

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

cran.r-project.org: bookdown

Rankings

Maintainers (1)

conda-forge.org: r-bookdown

Rankings

Dependencies