pkgdown

Generate static html documentation for an R package

https://github.com/r-lib/pkgdown

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
12 of 151 committers (7.9%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (19.9%) to scientific vocabulary

Keywords

documentation-tool package r

Keywords from Contributors

package-creation rmarkdown visualisation grammar data-manipulation latex pandoc literate-programming book bookdown

Last synced: 6 months ago · JSON representation

Repository

Generate static html documentation for an R package

Basic Info

Host: GitHub
Owner: r-lib
License: other
Language: R
Default Branch: main
Homepage: https://pkgdown.r-lib.org/
Size: 33.2 MB

Statistics

Stars: 750
Watchers: 15
Forks: 338
Open Issues: 51
Releases: 25

Topics

documentation-tool package r

Created almost 14 years ago · Last pushed 7 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Codeowners

README.Rmd

---
output: github_document
---



```{r}
#| echo: false
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/"
)
```

# pkgdown 


[![CRAN Status](https://www.r-pkg.org/badges/version/pkgdown)](https://cran.r-project.org/package=pkgdown){.pkgdown-release}
[![R-CMD-check](https://github.com/r-lib/pkgdown/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/pkgdown/actions/workflows/R-CMD-check.yaml){.pkgdown-devel}
[![Codecov test coverage](https://codecov.io/gh/r-lib/pkgdown/graph/badge.svg)](https://app.codecov.io/gh/r-lib/pkgdown)


pkgdown is designed to make it quick and easy to build a website for your package. You can see pkgdown in action at : this is the output of pkgdown applied to the latest version of pkgdown. Learn more in `vignette("pkgdown")` or `?build_site`.

## Installation

::: .pkgdown-release
```{r}
#| eval: false
# Install released version from CRAN
install.packages("pkgdown")
```
:::

::: .pkgdown-devel
```{r}
#| eval: false
# Install development version from GitHub
# install.packages("pak")
pak::pak("r-lib/pkgdown")
```
:::

## Usage

Get started with [usethis](https://usethis.r-lib.org/):

```{r}
#| eval: false
# Run once to configure your package to use and deploy pkgdown
usethis::use_pkgdown_github_pages()
```

```{r}
#| eval: false
# Preview your site locally before publishing
pkgdown::build_site()
```

This adds the necessary components and sets up GitHub Actions[^1] for automatic site building when deploying.
Your `README.md` becomes the homepage, documentation in `man/` generates a function reference, and vignettes will be rendered into `articles/`.

[^1]: If you don't use GitHub, you can use `usethis::use_pkgdown()` + `pkgdown::build_site()` to create a website.

### pkgdown 2.0.0 and Bootstrap 5

pkgdown 2.0.0 includes an upgrade from Bootstrap 3 to Bootstrap 5, which is accompanied by a whole bunch of minor UI improvements. If you've heavily customised your site, there's a small chance that this will break your site, so everyone needs to explicitly opt-in to the upgrade by adding the following to `_pkgdown.yml`:

```yaml
template:
  bootstrap: 5
```

Then learn about the many new ways to customise your site in `vignette("customise")`.

## In the wild

At last count, pkgdown is used [by over 12,000 packages](https://github.com/search?q=path%3A_pkgdown.yml+language%3AYAML&type=code&l=YAML). Here are a few examples:

* [bayesplot](http://mc-stan.org/bayesplot/index.html)
  ([source](https://github.com/stan-dev/bayesplot/tree/gh-pages)):
  plotting functions for posterior analysis, model checking, and MCMC
  diagnostics.

* [valr](https://rnabioco.github.io/valr/)
  ([source](https://github.com/rnabioco/valr)):
  read and manipulate genome intervals and signals.

* [mkin](https://pkgdown.jrwb.de/mkin/)
  ([source](https://github.com/jranke/mkin)):
  calculation routines based on the FOCUS Kinetics Report

* [NMF](http://renozao.github.io/NMF/master/index.html)
  ([source](https://github.com/renozao/NMF)):
  a framework to perform non-negative matrix factorization (NMF).

* [tidyverse and r-lib packages source](https://github.com/search?q=path%3A%22_pkgdown.yml%22+AND+%28org%3Atidyverse+OR+org%3Ar-lib%29&type=code)

Comparing the source and output of these sites is a great way to learn new pkgdown techniques.

## Code of conduct

Please note that this project is released with a [Contributor Code of Conduct](https://pkgdown.r-lib.org/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.

Owner

Name: R infrastructure
Login: r-lib
Kind: organization

Repositories: 154
Profile: https://github.com/r-lib

GitHub Events

Total

Create event: 26
Commit comment event: 1
Release event: 1
Issues event: 128
Watch event: 33
Delete event: 21
Issue comment event: 341
Push event: 175
Pull request review comment event: 52
Pull request review event: 54
Pull request event: 70
Fork event: 17

Last Year

Create event: 26
Commit comment event: 1
Release event: 1
Issues event: 128
Watch event: 33
Delete event: 21
Issue comment event: 341
Push event: 175
Pull request review comment event: 52
Pull request review event: 54
Pull request event: 70
Fork event: 17

Committers

Last synced: 8 months ago

All Time

Total Commits: 2,460
Total Committers: 151
Avg Commits per committer: 16.291
Development Distribution Score (DDS): 0.336

Past Year

Commits: 79
Committers: 29
Avg Commits per committer: 2.724
Development Distribution Score (DDS): 0.595

Top Committers

Name	Email	Commits
hadley	h**m@g**m	1,634
Jay Hesselberth	j**h@g**m	236
Maëlle Salmon	m**n@y**e	158
Kirill Müller	k****r	34
olivroy	5****y	22
Hugo Gruson	B****o	19
Jim Hester	j**r@g**m	15
Salim B	g**t@s**e	15
Garrick Aden-Buie	g**k@a**m	14
Jennifer (Jenny) Bryan	j**n@g**m	12
Christophe Dervieux	c**x@g**m	10
Jeroen Ooms	j**s@g**m	9
Johannes Ranke	j**e@u**e	9
Randy Lai	r**i@g**m	9
Winston Chang	w**n@s**g	9
adrtod	a**i@g**m	9
Max Held	i**o@m**e	8
Sebastian Meyer	s**r@f**e	8
Diego H	d**o@g**m	8
dmurdoch	m**n@g**m	7
Renaud Gaujoux	g**x@g**m	6
yang	y**i@g**m	6
Gábor Csárdi	c**r@g**m	6
Mara Averick	m**k@g**m	6
Neal Richardson	n**l@c**o	6
Renaud Gaujoux	r**d@c**a	5
Joe Cheng	j**e@r**m	5
Andrie de Vries	a**s@g**m	5
Iñaki Ucar	i**6@g**m	5
Ian Lyttle	i****e	4
and 121 more...

Committer Domains (Top 20 + Academic)

me.com: 4 rstudio.com: 2 salim.space: 1 adenbuie.com: 1 uni-bremen.de: 1 stdout.org: 1 maxheld.de: 1 fau.de: 1 crunch.io: 1 cbio.uct.ac.za: 1 ivt.baug.ethz.ch: 1 york.ac.uk: 1 ecos.au.dk: 1 cam.ac.uk: 1 qq.com: 1 uni-landau.de: 1 imsb.biol.ethz.ch: 1 u-bordeaux-montaigne.fr: 1 quants.ch: 1 hey.com: 1 uni-bielefeld.de: 1 cuanschutz.edu: 1 bsse.ethz.ch: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 426
Total pull requests: 553
Average time to close issues: 6 months
Average time to close pull requests: 28 days
Total issue authors: 204
Total pull request authors: 58
Average comments per issue: 2.62
Average comments per pull request: 1.75
Merged pull requests: 434
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 87
Pull requests: 83
Average time to close issues: 11 days
Average time to close pull requests: 10 days
Issue authors: 63
Pull request authors: 19
Average comments per issue: 1.76
Average comments per pull request: 2.36
Merged pull requests: 61
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

hadley (52)
maelle (35)
olivroy (26)
jayhesselberth (19)
MichaelChirico (7)
Bisaloo (6)
SebKrantz (6)
ramiromagno (6)
IndrajeetPatil (5)
jennybc (5)
trevorld (4)
rempsyc (4)
dvg-p4 (4)
salim-b (3)
gadenbuie (3)

Pull Request Authors

hadley (242)
jayhesselberth (65)
olivroy (50)
maelle (44)
salim-b (24)
jmaspons (7)
gadenbuie (7)
Bisaloo (6)
jennybc (5)
MichaelChirico (5)
krlmlr (4)
Rafnuss (4)
tanho63 (4)
cderv (4)
jplecavalier (4)

Top Labels

Issue Labels

feature (61) bug (46) front end :tulip: (37) documentation (23) upkeep (18) articles :writing_hand: (14) reference :books: (13) linking :paperclip: (11) home :house: (10) tidy-dev-day :nerd_face: (10) quarto (5) navbar :world_map: (4) news :newspaper: (3) deploy :airplane: (3) rd-translation :flags: (3) search :mag: (1) reprex (1) help wanted :heart: (1) translation :earth_asia: (1) math 🧮 (1)

Pull Request Labels

breaking change :skull_and_crossbones: (2) quarto (1)

Packages

Total packages: 2
Total downloads:
- cran 145,377 last-month
Total docker downloads: 46,956,802

Total dependent packages: 175
(may contain duplicates)
Total dependent repositories: 515
(may contain duplicates)
Total versions: 48
Total maintainers: 1

cran.r-project.org: pkgdown

Make Static HTML Documentation for a Package

Homepage: https://pkgdown.r-lib.org/
Documentation: http://cran.r-project.org/web/packages/pkgdown/pkgdown.pdf
License: MIT + file LICENSE
Latest release: 2.1.3
published 9 months ago

Versions: 24
Dependent Packages: 175
Dependent Repositories: 515
Downloads: 145,377 Last month
Docker Downloads: 46,956,802

Rankings

Downloads: 0.0%

Forks count: 0.1%

Stargazers count: 0.5%

Dependent packages count: 0.6%

Dependent repos count: 0.7%

Average: 3.2%

Docker downloads count: 17.3%

Maintainers (1)

hadley@posit.co

Last synced: 6 months ago

proxy.golang.org: github.com/r-lib/pkgdown

Documentation: https://pkg.go.dev/github.com/r-lib/pkgdown#section-documentation
License: other
Latest release: v2.1.3+incompatible
published 9 months ago

Versions: 24
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.5%

Average: 5.7%

Dependent repos count: 5.9%

Last synced: 6 months ago