retrieveExamplesFromMan: retrieveExamplesFromMan

View source: R/runExamplesWrapper.R

retrieveExamplesFromManR Documentation

retrieveExamplesFromMan

Description

retrieve the text of examples for man files

Usage

retrieveExamplesFromMan(package)

Arguments

package

character string full pathname for the package folder

Value

returns a list whose components are a list of examples text and a list of number of lines in each example text

Examples

## Not run: 
# replace package with your own version!!
dir1<-"~/personal/hearts/hearts_card_game_bayesian_inference/packages/"
dir2<-"inference_packages/inference_packages/"
dir<-sprintf("%s/%s",dir1,dir2)
pack<-"cardUtils"
package<-sprintf("%s/%s",dir,pack)
l<-retrieveExamplesFromMan(package)

## End(Not run)


runExamplesWrapper documentation built on April 12, 2025, 2:01 a.m.