93 create vignette for tcplplot #114
Conversation
Ashley-Ko
commented
Aug 2, 2023
Ashley-Ko
commented
- Added new section called "Plotting" to the data retrieval vignette with three subsections for pdf, jpg, and console output options.
- Included text from tcpl.R and manuscript to describe the functionality of the tcplPlot package and its parameters.
- Kept existing mc5 plots.
- Created three individual examples to illustrate the differences in multi, verbose, and output parameter types.
- Includes images of example plots - Created section for Plotting - Added text to describe section - Examples plots for pdf, jpg, and console output types and multi t/f and verbose t/f options.
…e "Plotting" section to included bullet points, rearranged plot order, and formatted package and variable names.
Ashley-Ko
requested review from
sedavid01,
kpaulfriedman,
cthunes,
Kelly-Carstens-EPA and
gracezhihuizhao
vignettes/Data_retrieval.Rmd
Outdated
|
|
||
| - The `verbose` parameter results in a plot that includes a table containing potency and model performance metrics; `verbose = FALSE` is default and the only option in console outputs. | ||
|
|
||
| - The `nrow` parameter specifies the number of rows in the multiple plots per page; this is 2 by default. The `ncol` parameter specifies the number of columns in the multiple plots per page; this is 3 by default. If `verbose = FALSE`, `ncol` is 2. `Nrow` and `ncol` can customize the number of plots included per page. |
There was a problem hiding this comment.
So, is there a maximum number of rows and columns that a user can set the output plots to be? That is, is the default multi plot 6 or 4 depending on the verbose parameter, then if a user wants more than that they can add it OR can users only define fewer plots displayed on the output multi plot? Basically what is the behavior of using multi, verbose, and nrow/ncol arguments together? Are there lower and upper bounds on various arguments being used together.
(Note: There does not need to be a whole lot of information but a concise summary of interdependencies/restrictions on these functional arguments may help users when they get started with tcplPlot.)
There was a problem hiding this comment.
@madison-feshuk @brown-jason Is there an upper limit to nrow or ncol?
There was a problem hiding this comment.
there is no real limit that we've programmed into the function.
There was a problem hiding this comment.
It appears that exceeding more than two rows does not reduce the plot size, but rather increases the length of the page. (ncol increases page width) An upper bounds is forced by ggsave. I got this error when trying to run nrow = 10 or ncol = 9
Error in `ggsave()`:
! Dimensions exceed 50 inches (`height` and `width` are specified in
inches not pixels).
ℹ If you're sure you want a plot that big, use `limitsize = FALSE`.
Is it worth mentioning an upper bounds if there is not a hard coded limit?
that verbose is before multi. - Updated the multi parameter description to reflect default values being set by verbose where multi = True. - Added the hard coded lower limit of 0 and technical limit of nrow = 9 and ncol = 7 to nrow/ncol description .
