Skip to contents

The action will depend on the status of the report:

  • queued - report run will be deleted

  • running - report run will be cancelled

  • complete/errored - no effect


orderly_cancel_remote(keys, root = NULL, locate = TRUE, remote = NULL)



The key or keys for the reports to cancel


The path to an orderly root directory, or NULL (the default) to search for one from the current working directory if locate is TRUE.


Logical, indicating if the configuration should be searched for. If TRUE and config is not given, then orderly looks in the working directory and up through its parents until it finds an orderly_config.yml file.


Description of the location. Typically this is a character string indicating a remote specified in the remotes block of your orderly_config.yml. It is also possible to pass in a directly created remote object (e.g., using orderly_remote_path(), or one provided by another package). If left NULL, then the default remote for this orderly repository is used - by default that is the first listed remote.


List with names as report keys and values are lists containing

  • killed - boolean TRUE if report successfully cancelled, FALSE otherwise

  • message - string detailing reason why cancellation failed