Refactor summary report generation: improve formatting and update example paths - #33
Refactor summary report generation: improve formatting and update example paths#33AbhirupaGhosh wants to merge 1 commit into
Conversation
| #' metadata_parquet = "data/metadata.parquet", | ||
| #' out_path = "data/" |
There was a problem hiding this comment.
I believe @examples will look for input files in a different location -- inst/extdata. right, @amcim @eboyer221? So that needs to be fixed -- until then, to avoid R CMD check errors, we may need to add \dontrun{}/\donttest{}.
There was a problem hiding this comment.
Yep, you're right @jananiravi. There's no example data actually included in the package (inst/extdata only has some reference files, not this kind of data), so this example won't run in an automated check.
Between \dontrun{} and \donttest{}: I'd go with \dontrun{} since it just skips the example entirely, which matches what we already do in the same situation elsewhere in the package.
There was a problem hiding this comment.
They're planning to add examples, Emily. Also, the examples will be visible on the help page but won't run when clicked on -- that's the distinction, right?
| #' Expects `metadata_parquet` to be the output of `runDataProcessing()`'s | ||
| #' `cleanData()` step (or an export of the resulting `metadata` table), since | ||
| #' Expects `metadata_parquet` to be the output of | ||
| #' `cleanMetadata()` step (or an export of the resulting `metadata` table), since |
There was a problem hiding this comment.
needs to be changed there or here. Metadata vs. MetaData. I would recomment Metadata. that's how it's used in retrieveMetadata
I changed the color to blue because we had a discussion to change the grey to blue during my poster preparation. |
I like blue more but tandem changes need to immediately go into amRviz so we don't forget. cc: @eboyer221 |
3 participants
No description provided.