stoRy (version 0.1.5)

storysets: Storysets objects

Description

The stoRy package uses the storysets object to store lists of story IDs.

Fields

Each storysets object has the following five fields

file

A string specifying the name of an .smt format storysets file. See examples.

names

A vector of storyset names.

comments

A vector of comments describing the storysets.

no_of_storysets

The number of storysets in the .smt file.

storysets_story_ids

A list of vectors containing the storyset story IDs.

Methods

Public methods

• storysets$new()

• storysets$print()

• storysets$clone()

Method new()

Usage

storysets$new(file)

Method print()

Usage

storysets$print(...)

Method clone()

The objects of this class are cloneable with this method.

Usage

storysets$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# NOT RUN {
#######################################################################
# List all storysets files available in the \pkg{stoRy} package       #
#######################################################################
list.files(system.file("storysets", package = "stoRy"))

#######################################################################
# Load the Star Trek aliens storysets smt file and storysets object   #
#######################################################################
file <- system.file("storysets", "aliens.smt", package = "stoRy")
mystorysets <- storysets$new(file)
print(mystorysets)
# }