Skip to content

Commit

Permalink
adds \donttest{} tag in examples with {MAE} (#555)
Browse files Browse the repository at this point in the history
# Pull Request

> (from CRAN) 
> ...
>  Lengthy examples (> 5 sec), can be wrapped in \donttest{}.
> ...

Partially fixes #554

Remaining examples will be addressed by #550

#### Changes description

- Changes `@examplesIf requireNamespace("MAE")` in favor of inline
conditional clause
- Surrounds `{MAE}` dependent examples with `\donttest{}` to avoid slow
examples
  • Loading branch information
averissimo authored and cicdguy committed Feb 6, 2024
1 parent 7af6b37 commit 78da058
Show file tree
Hide file tree
Showing 4 changed files with 138 additions and 129 deletions.
47 changes: 25 additions & 22 deletions R/FilteredDataset-utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -51,32 +51,35 @@
#' shinyApp(ui, server)
#' }
#'
#' @examplesIf requireNamespace("MultiAssayExperiment")
#' # MAEFilteredDataset example
#' library(shiny)
#' @examples
#' \donttest{
#' if (requireNamespace("MultiAssayExperiment", quietly = TRUE)) {
#' # MAEFilteredDataset example
#' library(shiny)
#'
#' data(miniACC, package = "MultiAssayExperiment")
#' data(miniACC, package = "MultiAssayExperiment")
#'
#' MAE_fd <- init_filtered_dataset(miniACC, "MAE")
#' ui <- fluidPage(
#' MAE_fd$ui_add(id = "add"),
#' MAE_fd$ui_active("dataset"),
#' verbatimTextOutput("call")
#' )
#' server <- function(input, output, session) {
#' MAE_fd$srv_add(id = "add")
#' MAE_fd$srv_active(id = "dataset")
#' output$call <- renderText({
#' paste(
#' vapply(MAE_fd$get_call(), deparse1, character(1), collapse = "\n"),
#' collapse = "\n"
#' )
#' })
#' MAE_fd <- init_filtered_dataset(miniACC, "MAE")
#' ui <- fluidPage(
#' MAE_fd$ui_add(id = "add"),
#' MAE_fd$ui_active("dataset"),
#' verbatimTextOutput("call")
#' )
#' server <- function(input, output, session) {
#' MAE_fd$srv_add(id = "add")
#' MAE_fd$srv_active(id = "dataset")
#' output$call <- renderText({
#' paste(
#' vapply(MAE_fd$get_call(), deparse1, character(1), collapse = "\n"),
#' collapse = "\n"
#' )
#' })
#' }
#' if (interactive()) {
#' shinyApp(ui, server)
#' }
#' }
#' if (interactive()) {
#' shinyApp(ui, server)
#' }
#'
#' @keywords internal
#' @export
init_filtered_dataset <- function(dataset, # nolint
Expand Down
87 changes: 45 additions & 42 deletions R/filter_panel_api.R
Original file line number Diff line number Diff line change
Expand Up @@ -60,56 +60,59 @@
#' # remove all states
#' clear_filter_states(datasets)
#'
#' @examplesIf requireNamespace("MultiAssayExperiment")
#'
#' # Requires MultiAssayExperiment from Bioconductor
#' data(miniACC, package = "MultiAssayExperiment")
#'
#' datasets <- init_filtered_data(list(mae = miniACC))
#' fs <- teal_slices(
#' teal_slice(
#' dataname = "mae", varname = "years_to_birth", selected = c(30, 50),
#' keep_na = TRUE, keep_inf = FALSE
#' ),
#' teal_slice(
#' dataname = "mae", varname = "vital_status", selected = "1",
#' keep_na = FALSE
#' ),
#' teal_slice(
#' dataname = "mae", varname = "gender", selected = "female",
#' keep_na = TRUE
#' ),
#' teal_slice(
#' dataname = "mae", varname = "ARRAY_TYPE", selected = "",
#' keep_na = TRUE, experiment = "RPPAArray", arg = "subset"
#' @examples
#' \donttest{
#' if (requireNamespace("MultiAssayExperiment", quietly = TRUE)) {
#' # Requires MultiAssayExperiment from Bioconductor
#' data(miniACC, package = "MultiAssayExperiment")
#'
#' datasets <- init_filtered_data(list(mae = miniACC))
#' fs <- teal_slices(
#' teal_slice(
#' dataname = "mae", varname = "years_to_birth", selected = c(30, 50),
#' keep_na = TRUE, keep_inf = FALSE
#' ),
#' teal_slice(
#' dataname = "mae", varname = "vital_status", selected = "1",
#' keep_na = FALSE
#' ),
#' teal_slice(
#' dataname = "mae", varname = "gender", selected = "female",
#' keep_na = TRUE
#' ),
#' teal_slice(
#' dataname = "mae", varname = "ARRAY_TYPE", selected = "",
#' keep_na = TRUE, experiment = "RPPAArray", arg = "subset"
#' )
#' )
#' )
#'
#' # set initial filter state
#' set_filter_state(datasets, filter = fs)
#' # set initial filter state
#' set_filter_state(datasets, filter = fs)
#'
#' # get filter state
#' get_filter_state(datasets)
#' # get filter state
#' get_filter_state(datasets)
#'
#' # modify filter state
#' set_filter_state(
#' datasets,
#' teal_slices(
#' teal_slice(dataname = "mae", varname = "years_to_birth", selected = c(40, 60))
#' # modify filter state
#' set_filter_state(
#' datasets,
#' teal_slices(
#' teal_slice(dataname = "mae", varname = "years_to_birth", selected = c(40, 60))
#' )
#' )
#' )
#'
#' # remove specific filters
#' remove_filter_state(
#' datasets,
#' teal_slices(
#' teal_slice(dataname = "mae", varname = "years_to_birth"),
#' teal_slice(dataname = "mae", varname = "vital_status")
#' # remove specific filters
#' remove_filter_state(
#' datasets,
#' teal_slices(
#' teal_slice(dataname = "mae", varname = "years_to_birth"),
#' teal_slice(dataname = "mae", varname = "vital_status")
#' )
#' )
#' )
#'
#' # remove all states
#' clear_filter_states(datasets)
#' # remove all states
#' clear_filter_states(datasets)
#' }
#' }
NULL

#' @rdname filter_state_api
Expand Down
87 changes: 44 additions & 43 deletions man/filter_state_api.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

46 changes: 24 additions & 22 deletions man/init_filtered_dataset.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 78da058

Please sign in to comment.