search

Dasonk / docstring

Provides docstring like functionality to R functions without requiring the need to create a package.
57 stars 6 forks source link

Add vignette #3

Closed Dasonk closed 7 years ago

Dasonk commented 7 years ago

A vignette would really help any potential users of this package.

Dasonk commented 7 years ago

Use this for vignette:

options(help_type="text")
p <- function(x, ...){cat(paste(readLines(x),collapse="\n"), "\n")}
options(pager=p)

That should allow the help page to just be read as output directly so we don't have to worry about screenshots.

.... that also gives me an idea of how we could implement testing...

Dasonk commented 7 years ago

Vignette added in commit 7777747eaed47452f367469379d7617fa175e3d7