# Creating Continuously Integrated Package Repositories from Manifests

## Documentation for package ‘GRANBase’ version 1.6.8

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

A B C D E G I L M N P R S T U W

## -- A --

addPkg-method | addPkg
archivedir | archivedir Return the full path to the archive directory for the final repository deployment.
archivedir-method | archivedir Return the full path to the archive directory for the final repository deployment.
available.packages | available.packages A generic for available.packages and a method for GRANRepository objects
available.packages,ANY | available.packages A generic for available.packages and a method for GRANRepository objects
available.packages,GRANRepository | available.packages A generic for available.packages and a method for GRANRepository objects
available.packages-method | available.packages A generic for available.packages and a method for GRANRepository objects

## -- B --

backup_archive | backup_archive Return path where packages are backed up by default when clearing the repo
backup_archive, | backup_archive Return path where packages are backed up by default when clearing the repo
backup_archive-method | backup_archive Return path where packages are backed up by default when clearing the repo
buildBadge | Create Badges for build status
buildBranchesInRepo | Build SCM Checkouts Into Repository Directory
buildReportURL | Constructs the gRAN build report URL
buildRiskReport | Build risk-assessment for proposed package updates
build_timeout | Get or set individual parameters on a GRANRepository object
build_timeout,GRANRepository | Get or set individual parameters on a GRANRepository object
build_timeout,RepoBuildParam | Get or set individual parameters on a GRANRepository object
build_timeout-method | Get or set individual parameters on a GRANRepository object
build_timeout<- | Get or set individual parameters on a GRANRepository object
build_timeout<-,GRANRepository | Get or set individual parameters on a GRANRepository object
build_timeout<-,RepoBuildParam | Get or set individual parameters on a GRANRepository object
build_timeout<--method | Get or set individual parameters on a GRANRepository object

## -- C --

checkout_dir | checkout_dir Return the directory that package sources will be checked-out into for use in the build process
checkout_dir,NULL | checkout_dir Return the directory that package sources will be checked-out into for use in the build process
checkout_dir-method | checkout_dir Return the directory that package sources will be checked-out into for use in the build process
check_note_ok | Get or set individual parameters on a GRANRepository object
check_note_ok,GRANRepository | Get or set individual parameters on a GRANRepository object
check_note_ok-method | Get or set individual parameters on a GRANRepository object
check_result_dir | check_result_dir Return the path where check results for packages will be deployed for use in the build report.
check_result_dir-method | check_result_dir Return the path where check results for packages will be deployed for use in the build report.
check_test_on | Get or set individual parameters on a GRANRepository object
check_test_on,GRANRepository | Get or set individual parameters on a GRANRepository object
check_test_on,RepoBuildParam | Get or set individual parameters on a GRANRepository object
check_test_on-method | Get or set individual parameters on a GRANRepository object
check_timeout | Get or set individual parameters on a GRANRepository object
check_timeout,GRANRepository | Get or set individual parameters on a GRANRepository object
check_timeout,RepoBuildParam | Get or set individual parameters on a GRANRepository object
check_timeout-method | Get or set individual parameters on a GRANRepository object
check_timeout<- | Get or set individual parameters on a GRANRepository object
check_timeout<-,GRANRepository | Get or set individual parameters on a GRANRepository object
check_timeout<-,RepoBuildParam | Get or set individual parameters on a GRANRepository object
check_timeout<--method | Get or set individual parameters on a GRANRepository object
check_warn_ok | Get or set individual parameters on a GRANRepository object
check_warn_ok,GRANRepository | Get or set individual parameters on a GRANRepository object
check_warn_ok-method | Get or set individual parameters on a GRANRepository object
clear_repo | Clear packages and temporary files from repo build process
clear_temp_fils | Clear packages and temporary files from repo build process
contrib.url | contrib.url A generic for contrib.url so that available.packages et al can interact with GRANRepository objects.
contrib.url,GRANRepository | contrib.url A generic for contrib.url so that available.packages et al can interact with GRANRepository objects.
contrib.url-method | contrib.url A generic for contrib.url so that available.packages et al can interact with GRANRepository objects.
coverage_report_dir | coverage_report_dir Return the path where test coverage reports for packages will be deployed for use in the build report.
coverage_report_dir-method | coverage_report_dir Return the path where test coverage reports for packages will be deployed for use in the build report.
createJSON | Create JSON representation of package information
createSticker | Create hex stickers for packages
createURL | Creates a href tag

## -- D --

deltaDF | Returns the difference between 2 data frames
destination | destination Return the full path to the contrib directory for the final repository deployment.
destination-method | destination Return the full path to the contrib directory for the final repository deployment.
dest_base | dest_base Return the full path to the contrib directory for the final repository deployment.
dest_base-method | dest_base Return the full path to the contrib directory for the final repository deployment.
determinePkgURL | Generate package's external URL after validation info as data.frame

## -- E --

emailNotifier | Send email notifications to maintainers whose builds failed
emailTag | Create a mailto tag for email IDs
email_notify | email_notify Should emails be sent for build failure notifications?
email_notify-method | email_notify Should emails be sent for build failure notifications?
email_options | email_options Email options for sending build failure notifications
email_options-method | email_options Email options for sending build failure notifications
encode_string | Convert string to numeric representation
errlogfile | Log file location of a GRAN (sub) repository
errlogfile-method | Log file location of a GRAN (sub) repository
extPkgURL | Wrapper for determinePkgURL
extPkgURL_old | Wrapper for determinePkgURL. Deprecate due to performance issues.
extra_fun | Get or set individual parameters on a GRANRepository object
extra_fun-method | Get or set individual parameters on a GRANRepository object

## -- G --

generateDescInfo | Converts a DESCRIPTION file to a data.frame
getFailureInfo | Creates a dataframe containing information regarding packages that had a failed status
getOS | Get the OS Type
GRANRepository | GRANRepository
GRANRepository-class | GRANRepository
GRANRepository-method | backup_archive Return path where packages are backed up by default when clearing the repo

## -- I --

identifyRisk | identifyRisk
install_packages-method | install_packages method for GRANRepository objects
install_result_dir | install_result_dir Return the path where instal results for packages will be deployed for use in the build report.
install_result_dir-method | install_result_dir Return the path where instal results for packages will be deployed for use in the build report.
install_test_on | Get or set individual parameters on a GRANRepository object
install_test_on,GRANRepository | Get or set individual parameters on a GRANRepository object
install_test_on,RepoBuildParam | Get or set individual parameters on a GRANRepository object
install_test_on-method | Get or set individual parameters on a GRANRepository object
isValidEmail | Checks whether an email ID is valid

## -- L --

loadRepo | Backwards compatible load utility
location-method | Retrieve the path to a GRAN (sub) repository
logfile | Log file location of a GRAN (sub) repository
logfile-method | Log file location of a GRAN (sub) repository
logfile-method,GRANRepository | Log file location of a GRAN (sub) repository
logfun,GRANRepository | Get or set individual parameters on a GRANRepository object
logfun-method | Get or set individual parameters on a GRANRepository object
logfun<-,GRANRepository | Get or set individual parameters on a GRANRepository object
logfun<--method | Get or set individual parameters on a GRANRepository object

## -- M --

makeRepo | makeRepo
makeRepo,character | makeRepo
makeRepo,GRANRepository | makeRepo
makeRepo,PkgManifest | makeRepo
makeRepo,SessionManifest | makeRepo
makeRepo-method | makeRepo
manifestHTML | manifestHTML

## -- N --

notifyManifest | Sends email notifications for a given manifest
notrack-method | notrack Return the directory which stores retreived versions of non-GRAN packages for use in virtual repositories

## -- P --

param | Extract parameter object
param,GRANRepository | Extract parameter object
param-method | Extract parameter object
param<- | Extract parameter object
param<-,GRANRepository | Extract parameter object
param<--method | Extract parameter object
pkgHTML | Create HTML splash pages for packages
pkg_doc_dir | pkg_doc_dir Return the path where test coverage reports for packages will be deployed for use in the build report.
pkg_doc_dir-method | pkg_doc_dir Return the path where test coverage reports for packages will be deployed for use in the build report.
pkg_log_dir | Get or set individual parameters on a GRANRepository object
pkg_log_dir,GRANRepository | Get or set individual parameters on a GRANRepository object
pkg_log_dir,RepoBuildParam | Get or set individual parameters on a GRANRepository object
pkg_log_dir-method | Get or set individual parameters on a GRANRepository object
pkg_log_file | Get or set individual parameters on a GRANRepository object
pkg_log_file,GRANRepository | Get or set individual parameters on a GRANRepository object
pkg_log_file,RepoBuildParam | Get or set individual parameters on a GRANRepository object
pkg_log_file-method | Get or set individual parameters on a GRANRepository object

## -- R --

readPkgsNEWS | Read and summarize the NEWS files for packages at risk (updatable)
relatedPkgs | Wrapper for dependsOnPkgs
repobase | repobase Generic accessor function to retreive the repo specific subdirectory within the base directory
repobase-method | repobase Generic accessor function to retreive the repo specific subdirectory within the base directory
RepoBuildParam | RepoBuildParam
RepoBuildParam-class | RepoBuildParam
RepoFromList | Create a GRANRepository object from a list
RepoToList | Transform a GRANRepository object into a list
repo_name | Get or set individual parameters on a GRANRepository object
repo_name,GRANRepository | Get or set individual parameters on a GRANRepository object
repo_name-method | Get or set individual parameters on a GRANRepository object
repo_results | Repository build results
repo_results,GRANRepository | Repository build results
repo_results-method | Repository build results
repo_results<- | Repository build results
repo_results<-,GRANRepository | Repository build results
repo_results<--method | Repository build results
repo_url | repo_url Return the url that the repository will be served at. This is the web address corresponding to repository, suitable for calling contrib.url. e.g http://www.website.com/gran/current/
repo_url,NULL | repo_url Return the url that the repository will be served at. This is the web address corresponding to repository, suitable for calling contrib.url. e.g http://www.website.com/gran/current/
repo_url-method | repo_url Return the url that the repository will be served at. This is the web address corresponding to repository, suitable for calling contrib.url. e.g http://www.website.com/gran/current/
reversals | Generate reverse dependency info as data.frame

## -- S --

saveRepo | Backwards compatible save utility
sendMail | Wrapper for sendmail, allows for multiple attachments to be sent
sh_init_script,GRANRepository | Get or set individual parameters on a GRANRepository object
sh_init_script-method | Get or set individual parameters on a GRANRepository object
sh_init_script<-,GRANRepository | Get or set individual parameters on a GRANRepository object
sh_init_script<--method | Get or set individual parameters on a GRANRepository object
sortDelimitedString | Alphabetically sort delimited strings
staging | staging Return the staging directory or the staging_logs to be used when building the repository. If the directory does not exist it will be created.
staging-method | staging Return the staging directory or the staging_logs to be used when building the repository. If the directory does not exist it will be created.
staging_logs | staging Return the staging directory or the staging_logs to be used when building the repository. If the directory does not exist it will be created.
staging_logs-method | staging Return the staging directory or the staging_logs to be used when building the repository. If the directory does not exist it will be created.
string2list | Converts delimited string to list
suspended_pkgs | Get or set individual parameters on a GRANRepository object
suspended_pkgs,GRANRepository | Get or set individual parameters on a GRANRepository object
suspended_pkgs-method | Get or set individual parameters on a GRANRepository object
suspended_pkgs<- | Get or set individual parameters on a GRANRepository object
suspended_pkgs<-,GRANRepository | Get or set individual parameters on a GRANRepository object
suspended_pkgs<--method | Get or set individual parameters on a GRANRepository object

## -- T --

temp_lib | temporary library
temp_lib,GRANRepository | temporary library
temp_lib-method | temporary library
temp_repo | Get or set individual parameters on a GRANRepository object
temp_repo,GRANRepository | Get or set individual parameters on a GRANRepository object
temp_repo-method | Get or set individual parameters on a GRANRepository object
testCoverage | Calculate and generate package code test coverage reports

## -- U --

updateArchive | Move older package sources to the Archive directory
use_cran_granbase | Get or set individual parameters on a GRANRepository object
use_cran_granbase,GRANRepository | Get or set individual parameters on a GRANRepository object
use_cran_granbase,RepoBuildParam | Get or set individual parameters on a GRANRepository object
use_cran_granbase-method | Get or set individual parameters on a GRANRepository object
use_cran_granbase<- | Get or set individual parameters on a GRANRepository object
use_cran_granbase<-,GRANRepository | Get or set individual parameters on a GRANRepository object
use_cran_granbase<-,RepoBuildParam | Get or set individual parameters on a GRANRepository object
use_cran_granbase<--method | Get or set individual parameters on a GRANRepository object

## -- W --

writeGRANLog | writeGRANLog