repobuildparam: ResultsRow
In GRANCore: Classes and Methods for 'GRANBase'

Description Usage Arguments Value Note Examples

A row from the 'results' slot in the GRANRepository object

Parameters for building a GRAN repository. Most behavior during the GRAN building process is specified via this object/constructor.

ResultsRow(name = NA_character_, building = TRUE, status = "ok",
  version = "0.0-0", lastAttempt = NA_character_,
  lastAttemptVersion = NA_character_,
  lastAttemptStatus = NA_character_, lastbuilt = NA_character_,
  lastbuiltversion = NA_character_, lastbuiltstatus = NA_character_,
  buildReason = NA_character_, maintainer = NA_character_,
  suspended = FALSE)

RepoBuildParam(basedir, repo_name = "current",
  temp_repo = file.path(basedir, repo_name, "tmprepo"),
  temp_checkout = file.path(basedir, "tmpcheckout"),
  errlog = file.path(basedir, repo_name, paste0("GRAN", repo_name,
  "-error.log")), logfile = file.path(basedir, repo_name, paste0("GRAN",
  repo_name, "-full.log")), check_note_ok = TRUE, check_warn_ok = TRUE,
  tempLibLoc = file.path(basedir, repo_name, "LibLoc"),
  extra_fun = function(...) NULL, destination = basedir, auth = "",
  dest_url = makeFileURL(normalizePath2(destination)),
  shell_init = character(), loginnerfun = writeGRANLog,
  install_test = TRUE, check_test = TRUE, use_cran_granbase = TRUE,
  archive_timing = 2, archive_retries = 2, build_timeout = 10 * 60,
  check_timeout = 15 * 60, email_notifications = FALSE,
  email_opts = list(smtp_server = "localhost", smtp_port = 25,
  sender_email = paste0("gran", repo_name, "@localhost"), unsubscribers =
  NULL), repo_archive = file.path(destination, repo_name, "src",
  "contrib", "Archive"), repo_metadata_dir = file.path(destination,
  repo_name, "src", "contrib", "Meta"), make_windows_bins = TRUE,
  platform = "", r_version = "", bioc_version = "")

`name`	Name of the package
`building`	Logical indicating whether the package is building
`status`	Status of the package build
`version`	Package version
`lastAttempt`	Last attempt time of package build
`lastAttemptVersion`	Package version when build was last attempted
`lastAttemptStatus`	Package build status of last attempt
`lastbuilt`	Last built time of package, if successful
`lastbuiltversion`	Last built version of package, if successful
`lastbuiltstatus`	Last built status of package, if successful
`buildReason`	The reason why the package build was attempted
`maintainer`	Package maintainer
`suspended`	Is the package suspended?
`basedir`	The base directory. By default the temporary repository, temporary install library, and package staging area will be located in <basedir>/<subrepoName>/, while the temporary source checkout will be in t he basedir itself.
`repo_name`	The name of the repository, e.g. stable or devel
`temp_repo`	Location to create the temporary repository
`temp_checkout`	Location to create temporary checkouts/copies of package source code
`errlog`	The file to append error output to during the building and testing processes
`logfile`	The file to append summary log information to during building and testing
`check_note_ok`	logical. Whether packages that raise notes during R CMD check should be considered to have passed
`check_warn_ok`	logical. Whether packages that raise warnings during R CMD check should be considered to have passed
`tempLibLoc`	Location to create the temporary installed package library for use during the testing process
`extra_fun`	currently ignored
`destination`	Base location (not including repository name) of the final repository to be built. NOTE: GRANBase:::buildReportURL() expects this argument to have a trailing slash.
`auth`	character. Authentication information required to add packages to the manifest.
`dest_url`	The base URL the destination directory corresponds to. The subrepository name will be appended to this to generate the URL used when installing from the repository.
`shell_init`	An optional shell script to source before invoking system commands, e.g. a bashrc file. Ignored if "" or not specified.
`loginnerfun`	The function to use to write log messages during the repository build process. It will be passed pkg, ..., errfile, logfile, and pkglog based on the other arguments to this function. Defaults to writeGRANLog specified as the full and error log locations, respectively.
`install_test`	logical. Should the install test be performed? Required to build packages with vignettes, and for the check test
`check_test`	logical. Should R CMD check be run on the packages as a cohort. Requires install test.
`use_cran_granbase`	logical. Currently ignored.
`archive_timing`	numeric. Number of seconds to wait between attempts to pull a package from the CRAN archive
`archive_retries`	numeric. Number of times to retry pulling a package from the CRAN archive.
`build_timeout`	numeric. Number of seconds before timeout during the build step for a single package. Defaults to 10 minutes.
`check_timeout`	numeric. Number of seconds before timeout during the check step for a single package. Defaults to 15 minutes.
`email_notifications`	logical. Should email notifications be sent regarding packages that fail to build on GRAN? Defaults to FALSE
`email_opts`	List. Email options for sending emails regarding packages that fail to build on GRAN. The list contains 4 elements: `smtp_server`: the SMTP server - defaults to "localhost", `smtp_port`: SMTP port number - defaults to 25, `sender_email`: Whom should the emails be sent as? Defaults to "gran<repo_name>@localhost", `unsubscribers`: Vector of Perl-style regexes for unsubscribers - defaults to NULL.
`repo_archive`	Archive directory where older package sources will be saved
`repo_metadata_dir`	Directory containing metadata files
`make_windows_bins`	Whether to make Windows binary packages
`platform`	Name of platform this GRANRepository is being build on
`r_version`	R version for this GRANRepository
`bioc_version`	Bioconductor version for this GRANRepository