chunkList-class: Class "chunkList"

In DynDoc: Dynamic document tools

Description

This class is essentially a wrapper for the codeChunk class. It contains all of the codeChunks from a vignette file.

Objects from the Class

Objects can be created by calls of the form new("chunkList", ...).

Slots

chunks:

Object of class "list" Stores a list of codeChunk objects, representing all of the code chunks from a vignette file.

evalEnv:

Object of class "environment" An environment used for evaluation of the code chunks.

Methods

show

signature(object = "chunkList"): Displays verbose information about the code chunks

chunks

signature(object = "chunkList"): Retrieves a list of codeChunk objects

getAllCodeChunks

signature(object = "chunkList"): Collapses all of the code chunks into one block of code and returns this

getChunk

signature(object = "chunkList"): Retrieves a specific code chunk

numChunks

signature(object = "chunkList"): Returns the number of code chunks in this object

setChunk<-

signature(object = "chunkList", value="character"): Changes the code in a given codeChunk contained by this object

summary

signature(object = "chunkList"): A less verbose display of information about the object

evalChunk

signature(object = "chunkList", pos="numeric"): Evaluates the code chunk at the specified position in the chunkList object

Author(s)

Jeff Gentry

See Also

Sweave, codeChunk, vignetteCode

Examples

    library("utils")
    testfile <- system.file("Sweave", "Sweave-test-1.Rnw", package="utils")
    z <- Stangle(testfile,driver=tangleToR)

Example output

DynDoc documentation built on Nov. 8, 2020, 6:48 p.m.