215 updated tcplPlot to return ggplot object if only 1 plot #275
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
output = "ggplot"
will return a ggplot object and will not save it to a file. Anyoutput
besides"console"
and"ggplot"
will save the ggplot to a file like normal; however, these will also return the ggplot object to the user's environment."console"
outputs (single comparison plots okay)verbose = FALSE
, the return is a standard ggplot object.verbose = TRUE
, the return contains both the ggplot object and verbose table arranged into gtable object, which is probably not desirable to work with. Users should expect to keepverbose = FALSE
to easily manipulate the ggplot object in their environment. Ifverbose = TRUE
andoutput = "ggplot"
, a related message is printed to the console.Closes #215.
I am updating the docs to reflect these changes in the other open tcplPlot PR, to avoid merge conflicts.