Skip to content

Commit

Permalink
Merge branch 'defunct-vegandocs'
Browse files Browse the repository at this point in the history
  • Loading branch information
jarioksa committed Jun 15, 2024
2 parents 12d66c1 + 561b2b0 commit 73d9c85
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
1 change: 0 additions & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@ importFrom(graphics, abline, arrows, axis, barplot, box, contour,
import(permute) ## vegan depends on permute: import everything
importFrom(utils, news, vignette, combn, flush.console, modifyList,
object.size, read.fortran, read.fwf, str)
importFrom(tools, Rd2txt, startDynamicHelp)
importFrom(grDevices, bmp, check.options, chull, col2rgb, dev.off,
heat.colors, jpeg, palette, pdf, png, postscript, rainbow,
rgb, svg, tiff, xfig, xy.coords)
Expand Down
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@
**vegan3d**). _This is experimental, and we may go to direct error,
depending on user experience: please comment!_

* relic function `vegandocs` is officially defunct. Better tools to
read **vegan** documentation are `browseVignettes("vegan")` and
`news(package="vegan")`.

# vegan 2.6-6.1

## Bug Fixes
Expand Down
8 changes: 3 additions & 5 deletions R/vegandocs.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@
doc <- match.arg(doc)
if (doc == "NEWS") {
.Defunct('news(package="vegan")')
news(package = "vegan")
} else if (doc %in% vignette(package="vegan")$results[, "Item"]) {
.Defunct('browseVignettes("vegan")')
vignette(doc, package = "vegan")
} else if (doc == "permutations") {
.Defunct('browseVignettes("permute")')
vignette(doc, package = "permute")
} else # last resort
file.show(system.file(package="vegan", doc))
} else { # last resort
.Defunct(gettextf('file.show(system.file(package="vegan", "%s"))', doc))
}
}

0 comments on commit 73d9c85

Please sign in to comment.