installPlays: Install Parsed Plays and Speeches Lists

Description Usage Arguments Details Value

Description

Installs all the plays whose keys, or uniquely identifying strings from their title, are supplied as what. Installing means storing the parsed plays and derived speeches lists in tables for the session. If the user has write permission on the installed package's directories, serialized versions will be written there, to be used in later R sessions, rather than recomputing the parse trees and speech lists.

Usage

1
installPlays(what = .playsTable$keys, report = TRUE)

Arguments

what

character vector identifying the plays to install. By default installs all the 37 plays (which can take a minute or more, depending on the hardware).

report

if TRUE (the default) the function will report its progress.

Details

Use of this function is never required. If a play is accessed as an object of class Play, the same information will be stored for the session and written to the package files, if the user has write permission. It's perhaps less likely to be confusing if the plays are installed initially, as access to the tables is essentially instantaneous. Unserializing the saved files may be mildly noticeable as a delay, and the initial parse and computation is roughly twice as long again.

Value

the vector of keys corresponding to the requested plays.


johnmchambers/shakespeare documentation built on May 19, 2019, 5:16 p.m.