updateDependencies: Update the dependencies

In LTLA/rebook: Re-using Content in Bioconductor Books

Update the dependencies

Description

Update the book package's DESCRIPTION file with the latest dependencies.

Usage

updateDependencies(
  dir = ".",
  path = file.path(dir, "DESCRIPTION"),
  extra = NULL,
  indent = 4,
  field = "Depends",
  ...
)

Arguments

dir	String containing the path to the directory containing the book.
path	String containing the path to the DESCRIPTION file.
extra	Character vector of extra packages to be added to imports, usually from packages that are in Suggests and thus not caught directly by scrapeDependencies.
indent	Integer scalar specifying the size of the indent to use when listing packages.
field	String specifying the dependency field to store the packages in. Defaults to "Suggests" by convention.
...	Further arguments to pass to scrapeDependencies.

Details

The book DESCRIPTION is useful for quick installation of all packages required across all chapters. For example, it is used by https://github.com/LTLA/TrojanBookBuilder to populate a trojan package's dependencies, ensuring that all packages are available when the book itself is compiled.

Value

The specified field in the DESCRIPTION file in dir is updated. NULL is invisibly returned.

Author(s)

Aaron Lun

Examples

dir <- tempfile()
dir.create(dir)

write(file=file.path(dir, "DESCRIPTION"), 
"Package: son.of.godzilla 
Version: 0.0.1
Description: Like godzilla, but smaller.")

tmp <- file.path(dir, "alpha.Rmd")
write(file=tmp, "```{r, echo=FALSE, results='asis'}
rebook::chapterPreamble()
```

```{r}
A::func
library(C)
```")

tmp <- file.path(dir, "bravo.Rmd")
write(file=tmp, "```{r, echo=FALSE, results='asis'}
rebook::chapterPreamble()
```

```{r}
require(D)
B::more
```")

updateDependencies(dir)
cat(readLines(file.path(dir, "DESCRIPTION")), sep="\n")

LTLA/rebook documentation built on June 5, 2023, 6:24 p.m.