biocBuildEmail: Create and copy e-mail package notification template to...

Description Usage Arguments Value sentHistory

View source: R/biocBuildEmail.R

Description

The biocBuildEmail function provides a template for notifying maintainers of errors in the Bioconductor Build System (BBS). This convenience function returns the body of the email from a template within the package and provides a copy in the clipboard.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
biocBuildEmail(
  pkg,
  version = c("release", "devel"),
  PS = character(1L),
  emailTemplate = .getTemplatePath(),
  core.name = NULL,
  core.email = NULL,
  core.id = NULL,
  textOnly = FALSE,
  dry.run = TRUE,
  resend = FALSE,
  verbose = FALSE
)

sentHistory()

Arguments

pkg

character(1) The name of the package in trouble

version

character() A vector indicating which version of Bioconductor the package is failing in (either 'release' or 'devel'; defaults to both)

PS

character(1) Postscript, an additional note to the recipient of the email (i.e., the package maintainer)

emailTemplate

character(1) The path to the email template. The default path lies in the 'inst' package folder.

core.name

character(1) The full name of the core team member

core.email

character(1) The Roswell Park email of the core team member

core.id

character(1) The internal identifier for the Roswell employee. This ID usually matches '^[A-Z]2[0-9]5' for more recent identifiers.

textOnly

logical(1) Whether to return the text of the email only. This avoids the use of the 'blastula' package and adds the text to the system clipboard if the 'clipr' package is installed (default: FALSE)

dry.run

logical(1) Display the email without sending to the recipient. It only works for HTML email reports and ignored when 'textOnly=TRUE'

resend

logical(1) Whether to force a resend of the email

verbose

logical(1) Whether to output full email information from 'smtp_send' (when ‘dry.run' is 'FALSE' and ’blastula' is installed)

Value

A character string of the email

sentHistory

Check the history of emails sent


BiocPkgTools documentation built on April 15, 2021, 6:01 p.m.