Rdo_show {Rdpack} | R Documentation |
Convert an Rd object to text and show it
Description
Render an Rd object as text and show it.
Usage
Rdo_show(rdo)
Arguments
rdo |
an Rd object |
Details
Rdo_show
renders the help page represented by rdo
as
text and shows it with file.show()
.
Rdo_show
is a simplified front end to utils::Rd2txt
.
See viewRd
for more complete rendering, including of
references and citations.
Value
Invisible NULL
.
The function is used for the side effect of showing the text
representation of rdo
.
Author(s)
Georgi N. Boshnakov
See Also
Examples
## create a minimal Rd object
u1 <- list_Rd(name = "Dummyname", alias = "Dummyallias1",
title = "Dummy title", description = "Dummy description",
Rd_class = TRUE )
## Not run:
## run this interactively:
Rdo_show(u1)
## End(Not run)
[Package Rdpack version 2.6 Index]