Learn R Programming

apollo (version 0.1.0)

apollo_addLog: Writes an entry to apolloLog

Description

Writes an entry to the apolloLog, which lives inside apollo_inputs.

Usage

apollo_addLog(title = "", content = "", apolloLog, book = 1)

Arguments

title

Character. Title of the log entry.

content

Content of the log entry. Can be a single element or a list. Each element will be converted to character using print, and concatenated with a line feed in between.

apolloLog

Environment. It contains the character vectors of titles and content.

book

Positive scalar integer. Book number inside the log (default is 1).

Value

TRUE if writing was succesful, FALSE if not.

Details

The variable apolloLog is an environment created inside apollo_inputs by apollo_validateInputs, but re-set by apollo_estimate. As an environment, it can be modified in place, i.e. all changes done within this function are recorded in apolloLog, even if it belongs to another environment.