inst/doc/maestro-1-quick-start.R

## -----------------------------------------------------------------------------
knitr::opts_chunk$set(
  collapse = FALSE,
  comment = "",
  out.width = "100%",
  cache = FALSE,
  asciicast_knitr_output = "html"
)

asciicast::init_knitr_engine(
  echo = TRUE,
  echo_input = FALSE,
  same_process = TRUE,
  startup = quote({
    library(maestro)
    set.seed(1) 
  })
)

options(asciicast_theme = "pkgdown")

## -----------------------------------------------------------------------------
library(maestro)

## ----echo=FALSE, error=FALSE, warning=FALSE, message=FALSE--------------------
dir.create("pipelines")
writeLines(
  "
  #' my_pipe maestro pipeline
  #'
  #' @maestroFrequency 1 day
  #' @maestroStartTime 2024-05-24
  #' @maestroTz UTC
  #' @maestroLogLevel INFO
  
  my_pipe <- function() {
  
    # Pipeline code
  }",
  con = "pipelines/my_pipe.R"
)

## ----eval=FALSE---------------------------------------------------------------
# #' my_pipe maestro pipeline
# #'
# #' @maestroFrequency 1 day
# #' @maestroStartTime 2024-05-24
# #' @maestroTz UTC
# #' @maestroLogLevel INFO
# 
# my_pipe <- function() {
# 
#   # Pipeline code
# }

## -----------------------------------------------------------------------------
#' my_pipe maestro pipeline
#'
#' @maestroFrequency 1 day
#' @maestroStartTime 2024-05-24
#' @maestroTz UTC
#' @maestroLogLevel INFO

my_pipe <- function() {

  random_data <- data.frame(
    letters = sample(letters, 10),
    numbers = sample.int(10)
  )
  
  write.csv(random_data, file = tempfile())
}

## ----example-pipe-------------------------------------------------------------
# create_pipeline(
#   pipe_name = "another_pipeline",
#   pipeline_dir = "pipelines",
#   frequency = "1 hour",
#   start_time = "2024-05-17 15:00:00",
#   tz = "America/Halifax",
#   log_level = "ERROR"
# )

## ----cleanup, echo=FALSE, message=FALSE, warning=FALSE------------------------
unlink("pipelines", recursive = TRUE)

Try the maestro package in your browser

Any scripts or data that you put into this service are public.

maestro documentation built on June 8, 2025, 10:44 a.m.