benchmark_cypress {shiny.benchmark}R Documentation

Run the performance test based on multiple commits using Cypress

Description

Run the performance test based on multiple commits using Cypress

Usage

benchmark_cypress(
  commit_list,
  cypress_dir,
  tests_pattern,
  app_dir,
  port,
  use_renv,
  renv_prompt,
  n_rep,
  debug
)

Arguments

commit_list

A list of commit hash codes, branches' names or anything else you can use with git checkout ...

cypress_dir

The directory with tests recorded by Cypress. It can also be a vector of the same size of commit_list

tests_pattern

Cypress/shinytest2 files pattern. E.g. 'shinytest2' It can also be a vector of the same size of commit_list. If it is NULL, all the content in cypress_dir/shinytest2_dir will be used

app_dir

The path to the application root

port

Port to run the app

use_renv

In case it is set as TRUE, package will try to apply renv::restore() in all branches. Otherwise, the current loaded list of packages will be used in all branches.

renv_prompt

Prompt the user before taking any action?

n_rep

Number of replications desired

debug

Logical. TRUE to display all the system messages on runtime

Value

Return a list with the collected performance times


[Package shiny.benchmark version 0.1.1 Index]