Nothing
#' Generates dataframe with all dependencies needed to install a package, in the order they will be loaded
#'
#'@param pkg character string, name of target package to load (and install if needed),
#'@param date character string (yyyy-mm-dd), or date value, with the date which determines the
#'version of the package, and all dependencies, to be loaded (and installed if needed).
#'@param include.suggests logical, defaults to `FALSE`. When set to `TRUE`, includes
#' dependencies classified in the DESCRIPTION file as `suggested`.
#'@param force.install logical, defaults to `FALSE`. When set to `TRUE`, the column `installed`
#'in the generated snowball is set FALSE for all packages, causing them to be installed even if already installed.
#'@return a dataframe with all packages that need to be installed, their version , whether they are installed, where
#'to obtain them if not locally available (CRAN vs MRAN), which date to use for MRAN,
#'installation time from source (in seconds), and local path for storage
#' @examples
#' \dontrun{
#' get.snowball("rio", "2020-07-12")
#'}
#' @export
#'
######################################################################################
#Outline
#
#0 If snowball already exists early return it
#1 Get dependencies
#2 Produce dep12 (topographical sort) to get order of installation
#3 Add pkg at the end
#4 Get the version of each package
#5 Make Snowball table
#6 Turn to data frame
######################################################################################
get.snowball <- function(pkg, date, include.suggests=FALSE, force.install=FALSE) {
#Validate date and include suggests
date <- as.DateYMD(date)
validate.TF(include.suggests)
validate.date(date)
#Ensure pkgs are loaded
load.cran.toc()
#0 If snowball already exists early return it
#Path to snowball
snowball_dir <- paste0(get.groundhog.folder() , '/snowballs_v2' )
#Snowball with and without suggests are different snowballs, so two possible rds files for any given pkg date
if (include.suggests==FALSE) snowball_file <- paste0(pkg , "_" , gsub( "-", "_" , date) , '.rds')
if (include.suggests==TRUE) snowball_file <- paste0(pkg , "_" , gsub( "-", "_" , date) , '_with_suggests.rds')
#Final path
snowball_path <- file.path(snowball_dir, snowball_file)
#Create snowball directory if it does not exist
if (!file.exists(snowball_dir)) dir.create(snowball_dir,recursive=TRUE, showWarnings = FALSE)
#If snowball has been saved, load and return it, but delete it so that if it fails next time it won't be here
if (file.exists(snowball_path)) {
#Load
snowball <- readRDS(snowball_path)
#Delete
unlink(snowball_path)
#Update if necessary if a borrowed package from groundhog-library to local-library goes missing
#Check for lost packages
loans.all <- get.loans(verfiy.package.exists=FALSE)
loans.still <- get.loans(verfiy.package.exists=TRUE)
loans.lost <- loans.all[!loans.all$md5 %in% loans.still$md5,]
#Update snowball setting lost packages (if any) as not installed
if (nrow(loans.lost)>0)
{
snowball$installed <- ifelse(snowball$pkg_vrs %in% loans.lost$pkg_vrs &
!snowball$pkg_vrs %in% get.ip("groundhog")$pkg_vrs
, FALSE, snowball$installed)
#If a pkg is lost, we force installed=FALSE, otherwise we keep what it is (which should be TRUE)
#since we only save a snowball upon installing successfully all of it
}
return(snowball)
}
# 1 Get dependencies
dep12 <- get.all.dependencies(pkg, date, include.suggests = include.suggests)
# 2 Produce dep12 (topographical sort) to get order of installation
k <- 0 # counter of iterations attempting to sort
indep <- c()
# In each loop we take all dependencies without dependencies and add them to the sequence of installation
# Do until all dependencies have been assigned an order (so dep12 is empty)
while (nrow(dep12) > 0) {
k <- k + 1
indep.rows <- !(dep12$dep2 %in% dep12$pkg) ## Find dependencies without dependencies TRUE/FALSE vector
# Add those dependencies to the list of independencies
indepk <- unique(as.character(dep12$dep2[indep.rows]))
indep <- c(indep, indepk)
# Drop those rows from both
dep12 <- dep12[!indep.rows, ]
# Safety valve in case loop impossible to end
if (k == 50000) {
break
}
}
#2.5 Drop base packages for those will be loaded explicitly by library() command
indep <- indep[!indep %in% base_pkg()]
# 3) Add pkg at the end
snowball.pkg <- c(indep, pkg)
# 4) Get the version of each package
#snowball.vrs <- vapply(snowball.pkg, get.version, date, FUN.VALUE = character(1))
snowball.vrs<-c()
for (k in 1:length(snowball.pkg)) {
snowball.vrs[k]=as.character(get.version(snowball.pkg[k],date=date))
}
snowball.pkg_vrs <- paste0(snowball.pkg, "_", snowball.vrs)
# 5 Snowball table with packages to be installed & necessary attributes (location, binary / source, etc)
#Installed?
ip.groundhog <- get.ip('groundhog') #utils #58
loans<-get.loans(verfiy.package.exists=TRUE) #utils #59: get data.frame with borrowed packages
# that are still found in local library
#If the pkg is found in either the local or groundhog folder, deem this TRUE
snowball.installed <- snowball.pkg_vrs %in% c(ip.groundhog$pkg_vrs, loans$pkg_vrs)
#Over-rule it if requested to install all
if (force.install==TRUE) snowball.installed < -FALSE
# Vector with paths
snowball.installation.path <- mapply(get.pkg_search_paths, snowball.pkg, snowball.vrs)
# No need to find the locations if everything is already installed. This also
# allows us to run offline in easy cases
if (all(snowball.installed)) {
return(
data.frame(
"pkg" = snowball.pkg,
"vrs" = snowball.vrs,
"pkg_vrs" = snowball.pkg_vrs, # Identify pkg
"installed" = TRUE, # Installed?
"from" = '', # Where to install from
"GRAN.date" = as.Date('1970-01-01'), # GRAN date
"installation.time" = 0, # time to install
"installation.path" = snowball.installation.path,
stringsAsFactors = FALSE
)
)
}
os <- get.os()
if (os!='other') {
#For windows and mac get binaries information
snowball.CRAN <- snowball.pkg_vrs %in% get.current.packages("binary")$pkg_vrs
snowball.GRAN.date <- as.Date(sapply(snowball.pkg_vrs, get.gran.binary.date , date=date), origin = "1970-01-01") # 5.3 Binary date in GRAN?
snowball.GRAN.date <- as.DateYMD(snowball.GRAN.date)
snowball.GRAN <- snowball.GRAN.date != "1970-01-01"
snowball.from <- ifelse(snowball.GRAN, "GRAN", "source") # GRAN if available, if not source
snowball.from <- ifelse(snowball.CRAN, "CRAN", snowball.from) # Replace GRAN if CRAN is available and using most recent version of R
} else {
#If os IS 'other'
n <- length(snowball.pkg_vrs)
snowball.CRAN <- rep(FALSE, n)
snowball.from <- rep('source', n)
snowball.GRAN.date <- rep(as.Date("1970-01-01"),n)
}
# Installation time from source
snowball.time <- round(mapply(get.installation.time, snowball.pkg, snowball.vrs), 0)
# Adjust installation time
adjustment <- 2.5 # install times in CRAN's page are systematically too long, this is an initial adjustment factor
snowball.time <- pmax(round(snowball.time / adjustment, 0), 1)
#6 data.frame()
snowball <- data.frame(
"pkg" = snowball.pkg,
"vrs" = snowball.vrs,
"pkg_vrs" = snowball.pkg_vrs, # Identify pkg
"installed" = snowball.installed, # Installed?
"from" = snowball.from, # Where to install from
"GRAN.date" = snowball.GRAN.date, # GRAN date, in case GRAN is tried
"installation.time" = snowball.time, # time to install
"installation.path" = snowball.installation.path,
stringsAsFactors = FALSE
)
#7 Base packages are always installed
snowball$installed <- ifelse(snowball$pkg %in% base_pkg(), TRUE,snowball$installed)
return(snowball)
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.