Stack Overflow
Stack Overflow

Questions tagged [pkgdown]

Use for questions about the pkgdown R package, used for semi-automatic building for package websites, written by Hadley Wickham.

60 questions
10
votes
3 answers

Include "All other functions" in a pkgdown reference yaml

I have a pkgdown site in which I group a number of functions into categories in the reference .yml file. I'm wondering if there is a way to put all of the functions which I didn't explicitly categorize into their own category. The only thought I had…
Shorpy
  • 1,549
  • 13
  • 28
6
votes
1 answer

How to successfully use {pkgdown} when `svglite` graphics device is used

To address an issue in my R package, I wish to try out an svglite graphics device for rendering ggplot plots: knitr::opts_chunk$set(dev = "svglite") But, if I do so, the {pkgdown} workflow fails (failure log) with the warning messages: 1:…
Indrajeet Patil
  • 4,673
  • 2
  • 20
  • 51
6
votes
1 answer

How to control the size of package logo in a pkgdown site

I added a pkgdown site to my vcdExtra package and cannot figure out how to control the size of the package hex logo that appears on the main page built by pkgdown, https://friendly.github.io/vcdExtra/index.html The README.md file contains a line to…
user101089
  • 3,756
  • 1
  • 26
  • 53
6
votes
1 answer

`README` badges not getting rendered properly in `pkgdown` website

I have thus far created 6 different pkgdown websites for my R packages (e.g., ggstatsplot, kittyR, etc.) and none of them ever had the following issue. For the first time, running the following command pkgdown::build_site( lazy = FALSE, …
Indrajeet Patil
  • 4,673
  • 2
  • 20
  • 51
6
votes
1 answer

path error in pkgdown article with multiple bibliographies

I have a vignette of a R-package with multiple bibliographies (MB), using a lua filter. When I try to turn the vignette with MB into a pkgdown article I got an error for the .lua and .bib files, that do not appeared with the…
Ferroao
  • 3,042
  • 28
  • 53
5
votes
1 answer

pkgdown fails parsing Rd files when examples are added

for some reason pkgdown is failing to parse one of the .Rd files that I have in my package. I found it fails when I add examples to the roxygen2 documentation using either the @examples tag or the @example inst/example/add.R alternative. I minimized…
R.Andres Castaneda
  • 718
  • 5
  • 10
5
votes
1 answer

Git doesn't know my name/email when Github Actions deploy R package documentation and breaks

For a while now I've been happily using Github's Actions to run my library's R CMD check and deploying the package's documentation. Suddenly the package action started failing with the following error: ── Commiting updated site…
Bernardo
  • 461
  • 7
  • 20
4
votes
1 answer

How to make tables appear with desired kableExtra theme on pkgdown website?

I am using pkgdown to build my package website. However, when utilizing kableExtra::kable_classic for my final table shown in my website in the Customizing with KableExtra section of my vignette titled "Introduction to panelsummary", I expected my…
mikeytop
  • 150
  • 9
4
votes
1 answer

pkgdown action failing at build XML

✖ Failed to build XML 3.99-0.3 Error: Error: Has anyone else experienced this error in the pkgdown github action? Looks like a bug in building the XML package itself, not sure if…
Harrison Tietze
  • 41
  • 1
4
votes
1 answer

r pkgdown docsearch algolia

I am having trouble understanding how to implement the docsearch snippet into my github pages (I am using bootstrap 3). From the package documentation: Once you have published your pkgdown website, submit the pkgdown site URL to Docsearch.…
Gerald T
  • 704
  • 3
  • 18
4
votes
0 answers

Environmental variable causes loop in pkgdown::build_suite()

This is a continuation from an earlier post (Include Shiny app in R package: Transfer an input parameter) that successfully resolved my question but that led to another problem. Basically, I am running a Shiny app as part of an R package. To do…
user2808302
3
votes
0 answers

Python and R Packages: Documentation together

I'm working on a package that has R and python versions. For the R package I used pkgdown for documentation. I would like to keep pkgdown because of the design and ease to use. Which is the best way to put the documentation for R and python…
Laura
  • 1,192
  • 2
  • 18
  • 36
3
votes
1 answer

how to list vignettes in a package in a README or related

In several packages, most recently the matlib package on github, https://github.com/friendly/matlib, I have a README.{md,Rmd} file that says something like A small collection of vignettes is now available. Use browseVignettes("matlib") to see…
user101089
  • 3,756
  • 1
  • 26
  • 53
3
votes
0 answers

Creating subsections in pkgdown function reference page (R)

How is it possible to create not only first-level but also second-level headers in function reference page of R package documentation created with pkgdown? Can I do this by modifying the _pkgdown.yml file? More details: An example of an R package…
GegznaV
  • 4,938
  • 4
  • 23
  • 43
3
votes
0 answers

Using a static (prebuilt) PDF vignette in R package website throw pkgdown::build_site

I'm using the following code to generate website for the R package: pkgdown::build_site( pkg = "." , examples = TRUE , document = TRUE , run_dont_run = FALSE , seed = 12345 , lazy = FALSE , override …
MYaseen208
  • 22,666
  • 37
  • 165
  • 309
1
2 3 4