diff --git a/DESCRIPTION b/DESCRIPTION index c735350..9b37dda 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,5 +1,5 @@ Package: archivist -Version: 1.9.7.0 +Version: 1.9.7.1 Type: Package Title: Tools for Storing, Restoring and Searching for R Objects Authors@R: c( diff --git a/NAMESPACE b/NAMESPACE index edf8067..d076946 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -12,19 +12,15 @@ export(aformat) export(ahistory) export(alink) export(aoptions) -export(archive) export(aread) export(asearch) export(asession) export(cache) -export(cloneGithubRepo) export(copyLocalRepo) export(copyRemoteRepo) -export(createEmptyGithubRepo) export(createEmptyLocalRepo) export(createEmptyRepo) export(createMDGallery) -export(deleteGithubRepo) export(deleteLocalRepo) export(deleteRepo) export(getRemoteHook) @@ -34,8 +30,6 @@ export(loadFromLocalRepo) export(loadFromRemoteRepo) export(multiSearchInLocalRepo) export(multiSearchInRemoteRepo) -export(pullRepo) -export(pushRepo) export(rmFromRepo) export(saveToRepo) export(searchInLocalRepo) @@ -55,8 +49,6 @@ export(zipLocalRepo) export(zipRemoteRepo) import(httr) importClassesFrom(RSQLite,SQLiteDriver) -importClassesFrom(git2r,cred_user_pass) -importClassesFrom(git2r,git_repository) importFrom(DBI,dbConnect) importFrom(DBI,dbDisconnect) importFrom(DBI,dbDriver) @@ -73,20 +65,8 @@ importFrom(grDevices,png) importFrom(graphics,barplot) importFrom(graphics,par) importFrom(graphics,plot) -importFrom(jsonlite,unbox) importFrom(lubridate,now) importFrom(magrittr,"%>%") importFrom(utils,head) importFrom(utils,tail) importFrom(utils,zip) -importMethodsFrom(git2r,add) -importMethodsFrom(git2r,clone) -importMethodsFrom(git2r,commit) -importMethodsFrom(git2r,cred_user_pass) -importMethodsFrom(git2r,discover_repository) -importMethodsFrom(git2r,in_repository) -importMethodsFrom(git2r,init) -importMethodsFrom(git2r,pull) -importMethodsFrom(git2r,push) -importMethodsFrom(git2r,remote_add) -importMethodsFrom(git2r,repository) diff --git a/R/createEmptyRepo.R b/R/createEmptyRepo.R index 975aa5b..4c91cbb 100644 --- a/R/createEmptyRepo.R +++ b/R/createEmptyRepo.R @@ -4,13 +4,8 @@ #' #' @description #' \code{createEmptyLocalRepo} creates an empty \link{Repository} in the given directory in which archived artifacts will be stored. -#' \code{createEmptyGithubRepo} creates a new GitHub repository with an empty \pkg{archivist}-like \link{Repository} and -#' also creates a local \code{Repository} with \code{createEmptyLocalRepo} which is git-synchronized with -#' new GitHub repository. \code{createEmptyRepo} is a wrapper around \code{createEmptyLocalRepo} and \code{createEmptyGithubRepo} -#' functions and by default triggers \code{createEmptyLocalRepo} to maintain consistency with the previous \pkg{archivist} versions (<1.8.6.0) -#' where there was only \code{createEmptyRepo} which created local \code{Repository}. To learn more about -#' \code{Archivist Integration With GitHub API} visit \link{archivist-github-integration} (\link{agithub}). -#' +#' \code{createEmptyRepo} is a wrapper around \code{createEmptyLocalRepo} to maintain consistency with the previous \pkg{archivist} versions (<1.8.6.0) +#' where there was only \code{createEmptyRepo} which created Local \code{Repository}. #' #' @details #' At least one Repository must be initialized before using other functions from the \pkg{archivist} package. @@ -35,7 +30,6 @@ #' After every \code{saveToRepo} call the database is refreshed. As a result, the artifact is available #' immediately in \code{backpack.db} database for other collaborators. #' -#' @param type A character. Whether to use \code{Local} or \code{Github} version while using \code{createEmptyRepo} wrapper. #' #' @param repoDir A character that specifies the directory for the Repository which is to be made. While working with GitHub Repository, this will #' be the directory of the synchronized Local Repository, in which the new Local Repository will be created (is \code{NULL} then is the same as \code{repo}). @@ -47,19 +41,6 @@ #' @param default If \code{default = TRUE} then \code{repoDir} (\code{repo}) is set as default local repository #' (for GitHub version also the \code{user} is set as default GitHub user). #' -#' @param repo While working with a Github repository. A character denoting new GitHub repository name. White spaces will be substitued with a dash. -#' @param github_token While working with a Github repository. An OAuth GitHub Token created with the \link{oauth2.0_token} function. See \link{archivist-github-integration}. -#' Can be set globally with \code{aoptions("github_token", github_token)}. -#' @param repoDescription While working with a Github repository. A character specifing the new GitHub repository description. -#' @param user While working with a Github repository. A character denoting GitHub user name. Can be set globally with \code{aoptions("user", user)}. -#' See \link{archivist-github-integration}. -#' @param password While working with a Github repository. A character denoting GitHub user password. Can be set globally with \code{aoptions("password", password)}. -#' See \link{archivist-github-integration}. -#' @param readmeDescription While working with a Github repository. A character of the content of \code{README.md} file. By default a description of \link{Repository}. -#' Can be set globally with \code{aoptions("readmeDescription", readmeDescription)}. In order to omit -#' \code{README.md} file set \code{aoptions("readmeDescription", NULL)}. -#' @param response A logical value. Should the GitHub API response be returned. -#' #' @author #' Marcin Kosinski, \email{m.p.kosinski@@gmail.com} #' @@ -92,94 +73,9 @@ #' #' rm( exampleRepoDir ) #' -#' ## GitHub version -#' -#' library(httr) -#' myapp <- oauth_app("github", -#' key = app_key, -#' secret = app_secret) -#' github_token <- oauth2.0_token(oauth_endpoints("github"), -#' myapp, -#' scope = "public_repo") -#' aoptions("github_token", github_token) -#' aoptions("user", user) -#' aoptions("password", password) -#' -#' createEmptyGithubRepo("Museum") -#' createEmptyGithubRepo("Museum-Extras", response = TRUE) -#' createEmptyGithubRepo("Gallery", readmeDescription = NULL) -#' createEmptyGithubRepo("Landfill", -#' repoDescription = "My models and stuff") -#' createEmptyGithubRepo("MuseumYYYY", repoDir = "Museum_YY") -#' -#' -#' -#' # empty Github Repository creation -#' -#' library(httr) -#' myapp <- oauth_app("github", -#' key = app_key, -#' secret = app_secret) -#' github_token <- oauth2.0_token(oauth_endpoints("github"), -#' myapp, -#' scope = "public_repo") -#' # setting options -#' aoptions("github_token", github_token) -#' aoptions("user", user) -#' aoptions("password", password) -#' -#' createEmptyGithubRepo("archive-test4", default = TRUE) -#' ## artifact's archiving -#' przyklad <- 1:100 -#' -#' # archiving -#' archive(przyklad) -> md5hash_path -#' -#' ## proof that artifact is really archived -#' showGithubRepo() # uses options from setGithubRepo -#' # let's remove przyklad -#' rm(przyklad) -#' # and load it back from md5hash_path -#' aread(md5hash_path) -#' -#' -#' # clone example -#' unlink("archive-test", recursive = TRUE) -#' cloneGithubRepo('https://github.com/MarcinKosinski/archive-test') -#' setGithubRepo(aoptions("user"), "archive-test") -#' data(iris) -#' archive(iris) -#' showGithubRepo() #' #' } #' @family archivist -#' @rdname createEmptyRepo -#' @export -createEmptyRepo <- function( repoDir, force = TRUE, default = FALSE, - repo, - github_token = aoptions("github_token"), - user = aoptions("user"), - #user.email = aoptions("user.email"), - password = aoptions("password"), - repoDescription = aoptions("repoDescription"), - readmeDescription = aoptions("readmeDescription"), - response = aoptions("response"), - type = "local"){ - stopifnot(is.character(type) & length(type) ==1 & type %in% c("local", "github")) - if (type == "local") { - createEmptyLocalRepo(repoDir = repoDir, force = force, default = default) - } else { - createEmptyGithubRepo(repo = repo, - github_token = github_token, - repoDir = repoDir, - user = user, - password = password, - repoDescription = repoDescription, - readmeDescription = readmeDescription, - response = response, default = default) - } - -} #' @rdname createEmptyRepo #' @export @@ -234,113 +130,7 @@ createEmptyLocalRepo <- function( repoDir, force = TRUE, default = FALSE ){ #' @rdname createEmptyRepo #' @export -createEmptyGithubRepo <- function(repo, - github_token = aoptions("github_token"), - user = aoptions("user"), - repoDir = NULL, - #user.email = aoptions("user.email"), - password = aoptions("password"), - repoDescription = aoptions("repoDescription"), - readmeDescription = aoptions("readmeDescription"), - response = aoptions("response"), - default = FALSE){ - stopifnot(is.character(repo) & length(repo) ==1) - stopifnot((is.character(repoDir) & length(repoDir) ==1) | (is.null(repoDir))) - stopifnot(is.character(repoDescription) & length(repoDescription) ==1) - #stopifnot(any(class(github_token) %in% "Token")) - stopifnot(is.character(user) & length(user)==1) - #stopifnot(is.character(user.email) & length(user.email)==1) - stopifnot(is.character(password) & length(password)==1) - stopifnot((is.character(readmeDescription) & length(readmeDescription)==1) | - is.null(readmeDescription)) - stopifnot(is.logical(response) & length(response) ==1) - - - stopifnot( is.logical( default ), length( default ) == 1 ) - repo <- gsub(pattern = " ", "-", repo) - - shortPath <- FALSE - if(is.null(repoDir)) { - shortPath <- TRUE - repoDir <- repo - } - - # httr imports are in archivist-package.R file - # creating an empty GitHub Repository - POST(url = "https://api.github.com/user/repos", - encode = "json", - body = list( - name = jsonlite::unbox(repo), - description = jsonlite::unbox(repoDescription) - ), - config = httr::config(token = github_token) - ) -> resp - - - # git2r imports are in the archivist-package.R - #path <- repoDir - dir.create(repoDir) - - if (!shortPath){ - dir.create(file.path(repoDir, repo)) - repoDir_path <- file.path(repoDir, repo) - } else { - repoDir_path <- repo - } - - # initialize local git repository - # git init - repoDir_git2r <- init(repoDir_path) - - ## Create and configure a user - # git config - added to Note section - #git2r::config(repo, ...) # if about to use, the add to archivist-package.R - - # archivist-like Repository creation - createEmptyRepo(repoDir = repoDir_path) - file.create(file.path(repoDir_path, "gallery", ".gitkeep")) - # git add - if (!is.null(readmeDescription)){ - file.create(file.path(repoDir_path, "README.md")) - writeLines(aoptions("readmeDescription"), file.path(repoDir_path, "README.md")) - add(repoDir_git2r, c("backpack.db", "gallery/", "README.md")) - } else { - add(repoDir_git2r, c("backpack.db", "gallery/")) - } - - # git commit - new_commit <- commit(repoDir_git2r, "archivist Repository creation.") - - # association of the local and GitHub git repository - # git add remote - remote_add(repoDir_git2r, - #"upstream2", - 'origin', - file.path("https://github.com", user, paste0(repo, ".git"))) - - # GitHub authorization - # to perform pull and push operations - cred <- git2r::cred_user_pass(user, - password) - - # push archivist-like Repository to GitHub repository - push(repoDir_git2r, - #name = "upstream2", - refspec = "refs/heads/master", - credentials = cred) - - if (response){ - return(resp) - } - - if (default) { - setLocalRepo(repoDir_path) - setGithubRepo(repo = repo, user = user) - } - -} - - +createEmptyRepo <- createEmptyLocalRepo addArtifact <- function( md5hash, name, dir ){ # creates connection and driver diff --git a/R/deleteRepo.R b/R/deleteRepo.R index 0e0e665..a97cedc 100644 --- a/R/deleteRepo.R +++ b/R/deleteRepo.R @@ -5,36 +5,18 @@ #' @description #' \code{deleteRepo} deletes the existing \link{Repository} from the given directory. #' As a result all artifacts from \code{gallery} folder are removed and database \code{backpack.db} -#' is deleted. \code{deleteGithubRepo} can delete whole GitHub-Repository or only archivist-like Repository -#' stored on a GitHub-Repository (then it requires more parameters to be specified). -#' To learn more about \code{Archivist Integration With GitHub API} visit -#' \link{archivist-github-integration} (\link{agithub}). -#' +#' is deleted. +#' #' @param repoDir A character that specifies the directory for the Repository #' which is to be deleted. #' @param deleteRoot A logical value that specifies if the repository root directory #' should be deleted for Local Repository or for GitHub whether to delete whole GitHub-Repository. #' @param unset A logical. If deleted \code{repoDir/repo} was set to be default Local/GitHub Repository #' and \code{unset} is TRUE, then \code{repoDir/repo} is unset as a default Local/GitHub Repository (\code{aoptions('repoDir/repo', NULL, T)}). -#' @param repo While working with a Github repository. A character denoting GitHub repository name to be deleted. -#' @param github_token While working with a Github repository. An OAuth GitHub Token created with the \link{oauth2.0_token} function. To delete GitHub Repository you -#' need to have \code{delete_repo} scope set - see examples. See \link{archivist-github-integration}. -#' Can be set globally with \code{aoptions("github_token", github_token)}. -#' @param user While working with a Github repository. A character denoting GitHub user name. Can be set globally with \code{aoptions("user", user)}. -#' See \link{archivist-github-integration}. -#' @param response A logical value. Should the GitHub API response be returned (only when \code{deleteRoot = TRUE}). -#' @param subdir Only when \code{deleteRoot = FALSE}. Subdirectory in which the archivist-Repository is stored on a GitHub Repository. -#' If it's in main directory, then specify to \code{NULL} (default). -#' @param password Only when \code{deleteRoot = FALSE}. While working with a Github repository. A character denoting GitHub user password. Can be set globally with \code{aoptions("password", password)}. -#' See \link{archivist-github-integration}. -#' @param type A character. Whether to use \code{Local} or \code{Github} version while using \code{deleteRepo} wrapper. #' #' @details #' -#' To delete GitHub Repository you -#' need to have \code{delete_repo} scope set - see examples. -#' -#' Since version 1.9 \code{deleteRepo} is a wrapper around \code{deleteLocalRepo} (in earlier versions deleteRepo) and \code{deleteGithubRepo} +#' Since version 1.9 \code{deleteRepo} is a wrapper around \code{deleteLocalRepo} (in earlier versions deleteRepo) and \link[archivist.github]{deleteGitHubRepo} #' functions and by default triggers \code{deleteLocalRepo} to maintain consistency with the previous \pkg{archivist} versions (<1.9.0) #' where there was only \code{deleteRepo} which deleted local \code{Repository}. #' @@ -53,25 +35,6 @@ #' \dontrun{ #' #' ######################## -#' #### GitHub version #### -#' ######################## -#' -#' library(httr) -#' myapp <- oauth_app("github", -#' key = app_key, -#' secret = app_secret) -#' github_token <- oauth2.0_token(oauth_endpoints("github"), -#' myapp, -#' scope = c("public_repo", -#' "delete_repo")) -#' aoptions("github_token", github_token) -#' aoptions("user", user) -#' aoptions("password", password) -#' -#' createEmptyGithubRepo("Museum") -#' deleteGithubRepo(repo = "Museum", deleteRoot = TRUE, response = TRUE) -#' -#' ######################## #' #### Local version #### #' ######################## #' @@ -185,39 +148,9 @@ #' # or if aoptions('repodir') == repodir then #' # deleteRepo(repoDir, deleteRoot = TRUE, unset = TRUE) #' -#' -#' -#' -#' #' } #' #' @family archivist -#' @rdname deleteRepo -#' @export -deleteRepo <- function(repoDir, repo, - github_token = aoptions("github_token"), - user = aoptions("user"), - password = aoptions("password"), - unset = FALSE, - deleteRoot = FALSE, - subdir = NULL, - response = aoptions("response"), - type = "local"){ - stopifnot(is.character(type) & length(type) ==1 & type %in% c("local", "github")) - if (type == "local") { - deleteLocalRepo(repoDir = repoDir, deleteRoot = deleteRoot, - unset = unset) - } else { - deleteGithubRepo(repo = repo, - github_token = github_token, - user = user, - password = password, - unset = unset, - deleteRoot = deleteRoot, - subdir = subdir, - response = response) - } -} #' @rdname deleteRepo #' @export @@ -247,57 +180,5 @@ deleteLocalRepo <- function(repoDir, deleteRoot = FALSE, unset = FALSE){ #' @rdname deleteRepo #' @export -deleteGithubRepo <- function(repo, - github_token = aoptions("github_token"), - user = aoptions("user"), - password = aoptions("password"), - unset = FALSE, - deleteRoot = FALSE, - subdir = NULL, - response = aoptions("response")) { - stopifnot(is.character(repo) & length(repo) ==1) - stopifnot(is.character(user) & length(user)==1) - - if (deleteRoot) { - DELETE(url = file.path("https://api.github.com/repos",user,repo), - config = httr::config(token = github_token) - ) -> resp - } else { - tempfile() -> tmpDir - # clone repo to tmpDir - cloneGithubRepo(file.path("https://github.com/", user, repo), - repoDir = tmpDir) -> clonedRepo - # remove archivist-repository - deleteLocalRepo(repoDir = file.path(tmpDir, - ifelse(is.null(subdir), "", subdir) - )) - # add changes to git - add(clonedRepo, c("backpack.db", "gallery/")) - # message - delete_commit <- commit(clonedRepo, "archivist Repository deletion.") - # GitHub authorization - # to perform pull and push operations - cred <- git2r::cred_user_pass(user, - password) - # push archivist-like Repository deletion to GitHub - push(clonedRepo, - refspec = "refs/heads/master", - credentials = cred) - - } - - if (unset) { - aoptions('repo', NULL,T) - } - - - if (response & deleteRoot){ - return(resp) - } - - -} - - - +deleteRepo <- deleteLocalRepo diff --git a/man/Repository.Rd b/man/Repository.Rd index 7995465..fa9a873 100644 --- a/man/Repository.Rd +++ b/man/Repository.Rd @@ -87,18 +87,15 @@ Other archivist: \code{\link{Tags}}, \code{\link{\%a\%}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/Tags.Rd b/man/Tags.Rd index 883ee7f..8ce53d6 100644 --- a/man/Tags.Rd +++ b/man/Tags.Rd @@ -398,18 +398,16 @@ Other archivist: \code{\link{Repository}}, \code{\link{\%a\%}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, - \code{\link{aoptions}}, \code{\link{archive}}, - \code{\link{archivist-github-integration}}, - \code{\link{archivist-package}}, \code{\link{aread}}, - \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, + \code{\link{aoptions}}, \code{\link{archivist-package}}, + \code{\link{aread}}, \code{\link{asearch}}, + \code{\link{asession}}, \code{\link{cache}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/addHooksToPrint.Rd b/man/addHooksToPrint.Rd index 13c7fa6..224ddf9 100644 --- a/man/addHooksToPrint.Rd +++ b/man/addHooksToPrint.Rd @@ -42,18 +42,16 @@ Other archivist: \code{\link{Repository}}, \code{\link{Tags}}, \code{\link{\%a\%}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, - \code{\link{aoptions}}, \code{\link{archive}}, - \code{\link{archivist-github-integration}}, - \code{\link{archivist-package}}, \code{\link{aread}}, - \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, + \code{\link{aoptions}}, \code{\link{archivist-package}}, + \code{\link{aread}}, \code{\link{asearch}}, + \code{\link{asession}}, \code{\link{cache}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/addTagsRepo.Rd b/man/addTagsRepo.Rd index 7415608..65786c6 100644 --- a/man/addTagsRepo.Rd +++ b/man/addTagsRepo.Rd @@ -98,18 +98,16 @@ Other archivist: \code{\link{Repository}}, \code{\link{Tags}}, \code{\link{\%a\%}}, \code{\link{addHooksToPrint}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, - \code{\link{aoptions}}, \code{\link{archive}}, - \code{\link{archivist-github-integration}}, - \code{\link{archivist-package}}, \code{\link{aread}}, - \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, + \code{\link{aoptions}}, \code{\link{archivist-package}}, + \code{\link{aread}}, \code{\link{asearch}}, + \code{\link{asession}}, \code{\link{cache}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/aformat.Rd b/man/aformat.Rd index f454322..dd81208 100644 --- a/man/aformat.Rd +++ b/man/aformat.Rd @@ -39,18 +39,16 @@ Other archivist: \code{\link{Repository}}, \code{\link{Tags}}, \code{\link{\%a\%}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{ahistory}}, \code{\link{alink}}, - \code{\link{aoptions}}, \code{\link{archive}}, - \code{\link{archivist-github-integration}}, - \code{\link{archivist-package}}, \code{\link{aread}}, - \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, + \code{\link{aoptions}}, \code{\link{archivist-package}}, + \code{\link{aread}}, \code{\link{asearch}}, + \code{\link{asession}}, \code{\link{cache}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/ahistory.Rd b/man/ahistory.Rd index 65cefaf..a0b7cd6 100644 --- a/man/ahistory.Rd +++ b/man/ahistory.Rd @@ -76,18 +76,16 @@ Other archivist: \code{\link{Repository}}, \code{\link{Tags}}, \code{\link{\%a\%}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{alink}}, - \code{\link{aoptions}}, \code{\link{archive}}, - \code{\link{archivist-github-integration}}, - \code{\link{archivist-package}}, \code{\link{aread}}, - \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, + \code{\link{aoptions}}, \code{\link{archivist-package}}, + \code{\link{aread}}, \code{\link{asearch}}, + \code{\link{asession}}, \code{\link{cache}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/alink.Rd b/man/alink.Rd index a14b440..e4d3f6b 100644 --- a/man/alink.Rd +++ b/man/alink.Rd @@ -90,18 +90,16 @@ Other archivist: \code{\link{Repository}}, \code{\link{Tags}}, \code{\link{\%a\%}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, - \code{\link{aoptions}}, \code{\link{archive}}, - \code{\link{archivist-github-integration}}, - \code{\link{archivist-package}}, \code{\link{aread}}, - \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, + \code{\link{aoptions}}, \code{\link{archivist-package}}, + \code{\link{aread}}, \code{\link{asearch}}, + \code{\link{asession}}, \code{\link{cache}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/archive.Rd b/man/archive.Rd deleted file mode 100644 index 09a5c4e..0000000 --- a/man/archive.Rd +++ /dev/null @@ -1,143 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/archive.R -\name{archive} -\alias{archive} -\title{Archive Artifact to Local and GitHub Repository} -\usage{ -archive(artifact, commitMessage = aoptions("commitMessage"), - repo = aoptions("repo"), user = aoptions("user"), - password = aoptions("password"), archiveData = aoptions("archiveData"), - archiveTags = aoptions("archiveTags"), - archiveMiniature = aoptions("archiveMiniature"), - archiveSessionInfo = aoptions("archiveSessionInfo"), - force = aoptions("force"), rememberName = aoptions("rememberName"), ..., - userTags = c(), silent = aoptions("silent"), ascii = aoptions("ascii"), - alink = aoptions("alink")) -} -\arguments{ -\item{artifact}{An artifact to be archived on Local and Github \link{Repository}.} - -\item{commitMessage}{A character denoting a message added to the commit while archiving \code{artifact} on GitHub Repository. -By default, an artifact's \link{md5hash} is added to the commit message when it is specified to \code{NULL}.} - -\item{repo}{A character denoting GitHub repository name and synchronized local existing directory in which an artifact will be saved.} - -\item{user}{A character denoting GitHub user name. Can be set globally with \code{aoptions("user", user)}. -See \link{archivist-github-integration}.} - -\item{password}{A character denoting GitHub user password. Can be set globally with \code{aoptions("password", password)}. -See \link{archivist-github-integration}.} - -\item{archiveData}{A logical value denoting whether to archive the data from the \code{artifact}.} - -\item{archiveTags}{A logical value denoting whether to archive Tags from the \code{artifact}.} - -\item{archiveMiniature}{A logical value denoting whether to archive a miniature of the \code{artifact}.} - -\item{archiveSessionInfo}{A logical value denoting whether to archive the session info that describes the context in this given artifact was created.} - -\item{force}{A logical value denoting whether to archive \code{artifact} if it is already archived in -a Repository.} - -\item{rememberName}{A logical value. Should not be changed by a user. It is a technical parameter.} - -\item{...}{Further arguments passed to \link{alink} function, when \code{alink} set to \code{TRUE} OR -graphical parameters denoting width and height of a miniature. See details. -Further arguments passed to \link{head}. See Details section in \link{saveToRepo} about \code{firtsRows} parameter} - -\item{userTags}{A character vector with Tags. These Tags will be added to the repository along with the artifact.} - -\item{silent}{If TRUE produces no warnings.} - -\item{ascii}{A logical value. An \code{ascii} argument is passed to \link{save} function.} - -\item{alink}{Logical. Whether the result should be put into \link{alink} function. Pass further arguments with \code{...} -parameter.} -} -\description{ -\code{archive} stores artifacts in the local \link{Repository} and automatically pushes archived -artifacts to the Github \code{Repository} with which the local \code{Repository} is synchronized -(via \link{createEmptyGithubRepo} or \link{cloneGithubRepo}). Function stores artifacts on the same -way as \link{saveToRepo} function. More archivist functionalities that integrate archivist and GitHub API - can be found here \link{archivist-github-integration} (\link{agithub}). -} -\examples{ -\dontrun{ - -# empty Github Repository creation - -library(httr) -myapp <- oauth_app("github", - key = app_key, - secret = app_secret) -github_token <- oauth2.0_token(oauth_endpoints("github"), - myapp, - scope = "public_repo") -# setting options -aoptions("github_token", github_token) -aoptions("user", user) -aoptions("password", user) - -createEmptyGithubRepo("archive-test4", default = TRUE) -## artifact's archiving -exampleVec <- 1:100 - -# archiving -archive(exampleVec) -> md5hash_path - -## proof that artifact is really archived -showGithubRepo() # uses options from setGithubRepo -# let's remove exampleVec -rm(exampleVec) -# and load it back from md5hash_path -aread(md5hash_path) - - -# clone example -unlink("archive-test", recursive = TRUE) -cloneGithubRepo('https://github.com/MarcinKosinski/archive-test') -setGithubRepo(aoptions("user"), "archive-test") -data(iris) -archive(iris) -showGithubRepo() - -## alink() option -vectorLong <- 1:100 -vectorShort <- 1:20 -# archiving -alink(archive(vectorLong)) -archive(vectorShort, alink = TRUE) -showGithubRepo() - - -} -} -\author{ -Marcin Kosinski, \email{m.p.kosinski@gmail.com} -} -\seealso{ -Other archivist: \code{\link{Repository}}, - \code{\link{Tags}}, \code{\link{\%a\%}}, - \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, - \code{\link{aformat}}, \code{\link{ahistory}}, - \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archivist-github-integration}}, - \code{\link{archivist-package}}, \code{\link{aread}}, - \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, - \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, - \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, - \code{\link{searchInLocalRepo}}, - \code{\link{setLocalRepo}}, - \code{\link{shinySearchInLocalRepo}}, - \code{\link{showLocalRepo}}, - \code{\link{splitTagsLocal}}, - \code{\link{summaryLocalRepo}}, - \code{\link{zipLocalRepo}} -} - diff --git a/man/archivist-github-integration.Rd b/man/archivist-github-integration.Rd deleted file mode 100644 index 02bd8f7..0000000 --- a/man/archivist-github-integration.Rd +++ /dev/null @@ -1,102 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/githubFunctionsDescription.R -\docType{class} -\name{archivist-github-integration} -\alias{agithub} -\alias{archivist-github-integration} -\title{Archivist Integration With GitHub API} -\description{ -Set of functions to integrate \link[archivist]{archivist-package} with -GitHub API \href{https://developer.github.com/v3/}{https://developer.github.com/v3/}. - -It is possible to create new GitHub repository with an empty \pkg{archivist}-like \link{Repository} -with \link{createEmptyGithubRepo} function. - -\link{archive} stores artifacts in the Local -\code{Repository} and automatically pushes archived artifacts to the Github -\code{Repository} with which the Local \code{Repository} is synchronized. - -\link{cloneGithubRepo} clones GitHub Repository into the local directory. - -\link{deleteGithubRepo} can delete whole GitHub-Repository or only archivist-like Repository -stored on a GitHub-Repository. - -\link{pushRepo} and \link{pullRepo} synchronize Local and GitHub (remote) Repository. -} -\details{ -To use this set of functionalities, one firstly has to authorize himselft to the GitHub API. -It can be done by creating \href{OAuth application on GitHub}{https://github.com/settings/developers} -(register new application). When application is created, one will have to copy its \code{Client ID} and -\code{Client Secret} and authorize his github user with this application by running those commands: - \itemize{ - \item \code{myapp <- oauth_app("github", key = Client_ID, secret = Client_Secret)}, - \item \code{github_token <- oauth2.0_token(oauth_endpoints("github"), myapp, scope = "public_repo")}. - } -The \code{scope} limits can be found here -\href{https://developer.github.com/v3/oauth/#scopes}{https://developer.github.com/v3/oauth/#scopes}. -Basically, this is how you grant an access to your application and give permissions. -With such a token one is authorized and can work with GitHub API and \pkg{archivist} -functions devoted to GitHub integration. - -To perform GitHub integration operations such as \code{push}, \code{pull}, \code{commit}, \code{add} etc. -a user has to pass his GitHub user name (\code{user.name} parameter), user email (\code{user.email} -parameter) and user password (\code{user.password} parameter). Those parameters can be set globbaly -with \code{aoptions("user.email", user.email)}, \code{aoptions("user.name", user.name)} -and \code{aoptions("user.password", user.password)}. -} -\note{ -Note that global configuration of the \code{git config} is used for initial commit. -One can later specify local configuration for the repository with \link[git2r]{config}, e.g -\code{config(repoName, user.name = "Alice", user.email = "mail_at_gmail.com")}. -} -\examples{ -\dontrun{ -library(httr) -myapp <- oauth_app("github", - key = app_key, - secret = app_secret) -github_token <- oauth2.0_token(oauth_endpoints("github"), - myapp, - scope = c("public_repo", - "delete_repo")) -aoptions("github_token", github_token) -aoptions("name", user.name) -aoptions("password", user.password) - -## here github_token is used -createEmptyGithubRepo("Museum") -createEmptyGithubRepo("Museum-Extras", response = TRUE) -createEmptyGithubRepo("Gallery", readme = NULL) -createEmptyGithubRepo("Landfill", repoDescription = "My models and stuff") - -} -} -\author{ -Marcin Kosinski, \email{m.p.kosinski@gmail.com} -} -\seealso{ -Other archivist: \code{\link{Repository}}, - \code{\link{Tags}}, \code{\link{\%a\%}}, - \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, - \code{\link{aformat}}, \code{\link{ahistory}}, - \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, \code{\link{archivist-package}}, - \code{\link{aread}}, \code{\link{asearch}}, - \code{\link{asession}}, \code{\link{cache}}, - \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, - \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, - \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, - \code{\link{searchInLocalRepo}}, - \code{\link{setLocalRepo}}, - \code{\link{shinySearchInLocalRepo}}, - \code{\link{showLocalRepo}}, - \code{\link{splitTagsLocal}}, - \code{\link{summaryLocalRepo}}, - \code{\link{zipLocalRepo}} -} - diff --git a/man/archivist-package.Rd b/man/archivist-package.Rd index fcac8b4..27f0157 100644 --- a/man/archivist-package.Rd +++ b/man/archivist-package.Rd @@ -37,18 +37,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, \code{\link{cache}}, - \code{\link{cloneGithubRepo}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/archivistOptions.Rd b/man/archivistOptions.Rd index 2edff8d..025444a 100644 --- a/man/archivistOptions.Rd +++ b/man/archivistOptions.Rd @@ -112,18 +112,16 @@ Other archivist: \code{\link{Repository}}, \code{\link{Tags}}, \code{\link{\%a\%}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, - \code{\link{alink}}, \code{\link{archive}}, - \code{\link{archivist-github-integration}}, - \code{\link{archivist-package}}, \code{\link{aread}}, - \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, + \code{\link{alink}}, \code{\link{archivist-package}}, + \code{\link{aread}}, \code{\link{asearch}}, + \code{\link{asession}}, \code{\link{cache}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/aread.Rd b/man/aread.Rd index 202cd1c..87020ad 100644 --- a/man/aread.Rd +++ b/man/aread.Rd @@ -48,18 +48,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{asearch}}, \code{\link{asession}}, \code{\link{cache}}, - \code{\link{cloneGithubRepo}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/asearch.Rd b/man/asearch.Rd index fb5108b..fe0681d 100644 --- a/man/asearch.Rd +++ b/man/asearch.Rd @@ -113,18 +113,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asession}}, \code{\link{cache}}, - \code{\link{cloneGithubRepo}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/asession.Rd b/man/asession.Rd index 0f7a547..bb18f03 100644 --- a/man/asession.Rd +++ b/man/asession.Rd @@ -40,18 +40,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{cache}}, - \code{\link{cloneGithubRepo}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/cache.Rd b/man/cache.Rd index 6dbabb2..458ec2e 100644 --- a/man/cache.Rd +++ b/man/cache.Rd @@ -92,18 +92,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cloneGithubRepo}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/cloneGithubRepo.Rd b/man/cloneGithubRepo.Rd deleted file mode 100644 index 866eed3..0000000 --- a/man/cloneGithubRepo.Rd +++ /dev/null @@ -1,106 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/cloneGithubRepo.R -\name{cloneGithubRepo} -\alias{cloneGithubRepo} -\title{Clone Github Repository} -\usage{ -cloneGithubRepo(repoURL, repoDir = NULL, default = FALSE, ...) -} -\arguments{ -\item{repoURL}{The remote repository to clone.} - -\item{repoDir}{Local directory to clone to. If \code{NULL}, by default, creates a local directory, -which corresponds to the name after last \code{/} in \code{repoURL}.} - -\item{default}{Sets cloned Repository as default Local and GitHub Repository. -If \code{default = TRUE} then \code{repoDir} (last piece of \code{repoURL}) is set as default Local Repository - and for GitHub repository also the \code{user} from \code{repoURL} is set as default GitHub user).} - -\item{...}{Further parameters passed to \link[git2r]{clone}.} -} -\description{ -\code{cloneGithubRepo} is a wrapper around \code{git clone} and clones GitHub Repository -into the \code{repoDir} directory. - -More archivist functionalities that integrate archivist and GitHub API can be found here \link{archivist-github-integration} (\link{agithub}). -} -\examples{ -\dontrun{ - -cloneGithubRepo("https://github.com/MarcinKosinski/Museum") -cloneGithubRepo("https://github.com/MarcinKosinski/Museum-Extra") - - -# empty Github Repository creation - -library(httr) -myapp <- oauth_app("github", - key = app_key, - secret = app_secret) -github_token <- oauth2.0_token(oauth_endpoints("github"), - myapp, - scope = "public_repo") -# setting options -aoptions("github_token", github_token) -aoptions("name", user_name) -aoptions("password", user_password) - -createEmptyGithubRepo("archive-test4") -setGithubRepo(aoptions("name"), "archive-test4") -## artifact's archiving -przyklad <- 1:100 - -# archiving -archive(przyklad) -> md5hash_path - -## proof that artifact is really archived -showGithubRepo() # uses options from setGithubRepo -# let's remove przyklad -rm(przyklad) -# and load it back from md5hash_path -aread(md5hash_path) - - -# clone example -unlink("archive-test", recursive = TRUE) -cloneGithubRepo('https://github.com/MarcinKosinski/archive-test') -setGithubRepo(aoptions("name"), "archive-test") -# equivalent is cloneGithubRepo('https://github.com/MarcinKosinski/archive-test', default = TRUE) -# check if default is set with -# aoptions('repoDir'); aoptions('repo'); aoptions('user') -data(iris) -archive(iris) -showGithubRepo() - - -} -} -\author{ -Marcin Kosinski, \email{m.p.kosinski@gmail.com} -} -\seealso{ -Other archivist: \code{\link{Repository}}, - \code{\link{Tags}}, \code{\link{\%a\%}}, - \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, - \code{\link{aformat}}, \code{\link{ahistory}}, - \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, - \code{\link{archivist-package}}, \code{\link{aread}}, - \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, - \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, - \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, - \code{\link{searchInLocalRepo}}, - \code{\link{setLocalRepo}}, - \code{\link{shinySearchInLocalRepo}}, - \code{\link{showLocalRepo}}, - \code{\link{splitTagsLocal}}, - \code{\link{summaryLocalRepo}}, - \code{\link{zipLocalRepo}} -} - diff --git a/man/copyToRepo.Rd b/man/copyToRepo.Rd index 15808bf..4916bd4 100644 --- a/man/copyToRepo.Rd +++ b/man/copyToRepo.Rd @@ -151,17 +151,14 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/createEmptyRepo.Rd b/man/createEmptyRepo.Rd index ae62be2..2e7f5b6 100644 --- a/man/createEmptyRepo.Rd +++ b/man/createEmptyRepo.Rd @@ -1,26 +1,13 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/createEmptyRepo.R -\name{createEmptyRepo} -\alias{createEmptyGithubRepo} +\name{createEmptyLocalRepo} \alias{createEmptyLocalRepo} \alias{createEmptyRepo} \title{Create an Empty Repository} \usage{ -createEmptyRepo(repoDir, force = TRUE, default = FALSE, repo, - github_token = aoptions("github_token"), user = aoptions("user"), - password = aoptions("password"), - repoDescription = aoptions("repoDescription"), - readmeDescription = aoptions("readmeDescription"), - response = aoptions("response"), type = "local") - createEmptyLocalRepo(repoDir, force = TRUE, default = FALSE) -createEmptyGithubRepo(repo, github_token = aoptions("github_token"), - user = aoptions("user"), repoDir = NULL, - password = aoptions("password"), - repoDescription = aoptions("repoDescription"), - readmeDescription = aoptions("readmeDescription"), - response = aoptions("response"), default = FALSE) +createEmptyRepo(repoDir, force = TRUE, default = FALSE) } \arguments{ \item{repoDir}{A character that specifies the directory for the Repository which is to be made. While working with GitHub Repository, this will @@ -32,36 +19,11 @@ Default set to \code{force = TRUE}.} \item{default}{If \code{default = TRUE} then \code{repoDir} (\code{repo}) is set as default local repository (for GitHub version also the \code{user} is set as default GitHub user).} - -\item{repo}{While working with a Github repository. A character denoting new GitHub repository name. White spaces will be substitued with a dash.} - -\item{github_token}{While working with a Github repository. An OAuth GitHub Token created with the \link{oauth2.0_token} function. See \link{archivist-github-integration}. -Can be set globally with \code{aoptions("github_token", github_token)}.} - -\item{user}{While working with a Github repository. A character denoting GitHub user name. Can be set globally with \code{aoptions("user", user)}. -See \link{archivist-github-integration}.} - -\item{password}{While working with a Github repository. A character denoting GitHub user password. Can be set globally with \code{aoptions("password", password)}. -See \link{archivist-github-integration}.} - -\item{repoDescription}{While working with a Github repository. A character specifing the new GitHub repository description.} - -\item{readmeDescription}{While working with a Github repository. A character of the content of \code{README.md} file. By default a description of \link{Repository}. -Can be set globally with \code{aoptions("readmeDescription", readmeDescription)}. In order to omit -\code{README.md} file set \code{aoptions("readmeDescription", NULL)}.} - -\item{response}{A logical value. Should the GitHub API response be returned.} - -\item{type}{A character. Whether to use \code{Local} or \code{Github} version while using \code{createEmptyRepo} wrapper.} } \description{ \code{createEmptyLocalRepo} creates an empty \link{Repository} in the given directory in which archived artifacts will be stored. -\code{createEmptyGithubRepo} creates a new GitHub repository with an empty \pkg{archivist}-like \link{Repository} and -also creates a local \code{Repository} with \code{createEmptyLocalRepo} which is git-synchronized with -new GitHub repository. \code{createEmptyRepo} is a wrapper around \code{createEmptyLocalRepo} and \code{createEmptyGithubRepo} - functions and by default triggers \code{createEmptyLocalRepo} to maintain consistency with the previous \pkg{archivist} versions (<1.8.6.0) - where there was only \code{createEmptyRepo} which created local \code{Repository}. To learn more about - \code{Archivist Integration With GitHub API} visit \link{archivist-github-integration} (\link{agithub}). +\code{createEmptyRepo} is a wrapper around \code{createEmptyLocalRepo} to maintain consistency with the previous \pkg{archivist} versions (<1.8.6.0) + where there was only \code{createEmptyRepo} which created Local \code{Repository}. } \details{ At least one Repository must be initialized before using other functions from the \pkg{archivist} package. @@ -115,64 +77,6 @@ deleteRepo("def", TRUE) rm( exampleRepoDir ) -## GitHub version - -library(httr) -myapp <- oauth_app("github", - key = app_key, - secret = app_secret) -github_token <- oauth2.0_token(oauth_endpoints("github"), - myapp, - scope = "public_repo") -aoptions("github_token", github_token) -aoptions("user", user) -aoptions("password", password) - -createEmptyGithubRepo("Museum") -createEmptyGithubRepo("Museum-Extras", response = TRUE) -createEmptyGithubRepo("Gallery", readmeDescription = NULL) -createEmptyGithubRepo("Landfill", - repoDescription = "My models and stuff") -createEmptyGithubRepo("MuseumYYYY", repoDir = "Museum_YY") - - - -# empty Github Repository creation - -library(httr) -myapp <- oauth_app("github", - key = app_key, - secret = app_secret) -github_token <- oauth2.0_token(oauth_endpoints("github"), - myapp, - scope = "public_repo") -# setting options -aoptions("github_token", github_token) -aoptions("user", user) -aoptions("password", password) - -createEmptyGithubRepo("archive-test4", default = TRUE) -## artifact's archiving -przyklad <- 1:100 - -# archiving -archive(przyklad) -> md5hash_path - -## proof that artifact is really archived -showGithubRepo() # uses options from setGithubRepo -# let's remove przyklad -rm(przyklad) -# and load it back from md5hash_path -aread(md5hash_path) - - -# clone example -unlink("archive-test", recursive = TRUE) -cloneGithubRepo('https://github.com/MarcinKosinski/archive-test') -setGithubRepo(aoptions("user"), "archive-test") -data(iris) -archive(iris) -showGithubRepo() } } @@ -185,17 +89,14 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/createMDGallery.Rd b/man/createMDGallery.Rd index e15acc1..0d82647 100644 --- a/man/createMDGallery.Rd +++ b/man/createMDGallery.Rd @@ -65,17 +65,14 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/deleteRepo.Rd b/man/deleteRepo.Rd index 2a3b466..0e23854 100644 --- a/man/deleteRepo.Rd +++ b/man/deleteRepo.Rd @@ -1,64 +1,31 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/deleteRepo.R -\name{deleteRepo} -\alias{deleteGithubRepo} +\name{deleteLocalRepo} \alias{deleteLocalRepo} \alias{deleteRepo} \title{Delete the Existing Repository from the Given Directory} \usage{ -deleteRepo(repoDir, repo, github_token = aoptions("github_token"), - user = aoptions("user"), password = aoptions("password"), unset = FALSE, - deleteRoot = FALSE, subdir = NULL, response = aoptions("response"), - type = "local") - deleteLocalRepo(repoDir, deleteRoot = FALSE, unset = FALSE) -deleteGithubRepo(repo, github_token = aoptions("github_token"), - user = aoptions("user"), password = aoptions("password"), unset = FALSE, - deleteRoot = FALSE, subdir = NULL, response = aoptions("response")) +deleteRepo(repoDir, deleteRoot = FALSE, unset = FALSE) } \arguments{ \item{repoDir}{A character that specifies the directory for the Repository which is to be deleted.} -\item{repo}{While working with a Github repository. A character denoting GitHub repository name to be deleted.} - -\item{github_token}{While working with a Github repository. An OAuth GitHub Token created with the \link{oauth2.0_token} function. To delete GitHub Repository you -need to have \code{delete_repo} scope set - see examples. See \link{archivist-github-integration}. -Can be set globally with \code{aoptions("github_token", github_token)}.} - -\item{user}{While working with a Github repository. A character denoting GitHub user name. Can be set globally with \code{aoptions("user", user)}. -See \link{archivist-github-integration}.} - -\item{password}{Only when \code{deleteRoot = FALSE}. While working with a Github repository. A character denoting GitHub user password. Can be set globally with \code{aoptions("password", password)}. -See \link{archivist-github-integration}.} - -\item{unset}{A logical. If deleted \code{repoDir/repo} was set to be default Local/GitHub Repository -and \code{unset} is TRUE, then \code{repoDir/repo} is unset as a default Local/GitHub Repository (\code{aoptions('repoDir/repo', NULL, T)}).} - \item{deleteRoot}{A logical value that specifies if the repository root directory should be deleted for Local Repository or for GitHub whether to delete whole GitHub-Repository.} -\item{subdir}{Only when \code{deleteRoot = FALSE}. Subdirectory in which the archivist-Repository is stored on a GitHub Repository. -If it's in main directory, then specify to \code{NULL} (default).} - -\item{response}{A logical value. Should the GitHub API response be returned (only when \code{deleteRoot = TRUE}).} - -\item{type}{A character. Whether to use \code{Local} or \code{Github} version while using \code{deleteRepo} wrapper.} +\item{unset}{A logical. If deleted \code{repoDir/repo} was set to be default Local/GitHub Repository +and \code{unset} is TRUE, then \code{repoDir/repo} is unset as a default Local/GitHub Repository (\code{aoptions('repoDir/repo', NULL, T)}).} } \description{ \code{deleteRepo} deletes the existing \link{Repository} from the given directory. As a result all artifacts from \code{gallery} folder are removed and database \code{backpack.db} -is deleted. \code{deleteGithubRepo} can delete whole GitHub-Repository or only archivist-like Repository -stored on a GitHub-Repository (then it requires more parameters to be specified). -To learn more about \code{Archivist Integration With GitHub API} visit - \link{archivist-github-integration} (\link{agithub}). +is deleted. } \details{ -To delete GitHub Repository you -need to have \code{delete_repo} scope set - see examples. - -Since version 1.9 \code{deleteRepo} is a wrapper around \code{deleteLocalRepo} (in earlier versions deleteRepo) and \code{deleteGithubRepo} +Since version 1.9 \code{deleteRepo} is a wrapper around \code{deleteLocalRepo} (in earlier versions deleteRepo) and \link[archivist.github]{deleteGitHubRepo} functions and by default triggers \code{deleteLocalRepo} to maintain consistency with the previous \pkg{archivist} versions (<1.9.0) where there was only \code{deleteRepo} which deleted local \code{Repository}. } @@ -73,25 +40,6 @@ webpage. \examples{ \dontrun{ -######################## -#### GitHub version #### -######################## - -library(httr) -myapp <- oauth_app("github", - key = app_key, - secret = app_secret) -github_token <- oauth2.0_token(oauth_endpoints("github"), - myapp, - scope = c("public_repo", - "delete_repo")) -aoptions("github_token", github_token) -aoptions("user", user) -aoptions("password", password) - -createEmptyGithubRepo("Museum") -deleteGithubRepo(repo = "Museum", deleteRoot = TRUE, response = TRUE) - ######################## #### Local version #### ######################## @@ -206,10 +154,6 @@ deleteRepo(repoDir = "defRepo", deleteRoot = TRUE) # or if aoptions('repodir') == repodir then # deleteRepo(repoDir, deleteRoot = TRUE, unset = TRUE) - - - - } } @@ -222,18 +166,14 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, \code{\link{createMDGallery}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/getRemoteHook.Rd b/man/getRemoteHook.Rd index 9094bc0..574922d 100644 --- a/man/getRemoteHook.Rd +++ b/man/getRemoteHook.Rd @@ -42,18 +42,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/getTags.Rd b/man/getTags.Rd index 4c11c95..6744522 100644 --- a/man/getTags.Rd +++ b/man/getTags.Rd @@ -142,18 +142,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, @@ -167,18 +164,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/loadFromRepo.Rd b/man/loadFromRepo.Rd index 7bbbd1e..34fa3a4 100644 --- a/man/loadFromRepo.Rd +++ b/man/loadFromRepo.Rd @@ -265,17 +265,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, - \code{\link{md5hash}}, \code{\link{pushRepo}}, - \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, + \code{\link{md5hash}}, \code{\link{rmFromRepo}}, + \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/magrittr.Rd b/man/magrittr.Rd index 8aa0bce..5c3b07c 100644 --- a/man/magrittr.Rd +++ b/man/magrittr.Rd @@ -64,18 +64,16 @@ Other archivist: \code{\link{Repository}}, \code{\link{Tags}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, - \code{\link{aoptions}}, \code{\link{archive}}, - \code{\link{archivist-github-integration}}, - \code{\link{archivist-package}}, \code{\link{aread}}, - \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, + \code{\link{aoptions}}, \code{\link{archivist-package}}, + \code{\link{aread}}, \code{\link{asearch}}, + \code{\link{asession}}, \code{\link{cache}}, \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/md5hash.Rd b/man/md5hash.Rd index b292dc4..cbe30ab 100644 --- a/man/md5hash.Rd +++ b/man/md5hash.Rd @@ -57,16 +57,14 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, - \code{\link{loadFromLocalRepo}}, \code{\link{pushRepo}}, + \code{\link{loadFromLocalRepo}}, \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, diff --git a/man/pushRepo.Rd b/man/pushRepo.Rd deleted file mode 100644 index 8f41b62..0000000 --- a/man/pushRepo.Rd +++ /dev/null @@ -1,95 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/push_pull_Repo.R -\name{pushRepo} -\alias{pullRepo} -\alias{pushRepo} -\title{Push and Pull for Local Repository Synchronized with GitHub} -\usage{ -pushRepo(repoDir = aoptions("repoDir"), - commitMessage = aoptions("commitMessage"), repo = aoptions("repo"), - user = aoptions("user"), password = aoptions("password"), - files = c("gallery", "backpack.db"), ...) - -pullRepo(repoDir = aoptions("repoDir"), user = aoptions("user"), - password = aoptions("password"), ...) -} -\arguments{ -\item{repoDir}{A character specifing the directory to Local \code{Repository} to/from which artifacts will be pulled/pushed to GitHub.} - -\item{commitMessage}{A character denoting a message added to the commit while performing push. -By default specified to \code{NULL} which corresponds to commit message \code{archivist: pushRepo}.} - -\item{repo}{A character denoting GitHub repository name and synchronized local existing directory in which an artifact will be saved.} - -\item{user}{A character denoting GitHub user name. Can be set globally with \code{aoptions("user", user)}. -See \link{archivist-github-integration}.} - -\item{password}{A character denoting GitHub user password. Can be set globally with \code{aoptions("password", password)}. -See \link{archivist-github-integration}.} - -\item{files}{A character vector containing directories to files that should be commited and pushed. The working directory -is \code{repoDir}. By default all uncommited artifacts and \code{backpack.db} will be pushed.} - -\item{...}{Further arguments passed to \link[git2r]{push} or \link[git2r]{pull}.} -} -\description{ -\code{pushRepo} adds files, commits them and pushes from Local \link{Repository} to synchronized GitHub one. -\code{pullRepo} pulls (\code{git pull}) changes from remote GitHub \code{Repository} to the correspoding Local one. -More archivist functionalities that integrate archivist and GitHub API can be found here \link{archivist-github-integration} (\link{agithub}). -} -\note{ -To check the \code{status} (\code{git status}) of the Repository use \code{git2r::status(repository(repoDir))}. See examples. -} -\examples{ -\dontrun{ - -library(httr) -myapp <- oauth_app("github", - key = app_key, - secret = app_secret) -github_token <- oauth2.0_token(oauth_endpoints("github"), - myapp, - scope = c("public_repo", - "delete_repo")) -aoptions("github_token", github_token) -aoptions("name", user.name) -aoptions("password", user.password) - -createEmptyGithubRepo("Museum", default = TRUE) # here github_token is used -data(iris) -saveToRepo(iris) -git2r::status(repository('Museum')) -pushRepo(commitMessage = "add iris") -git2r::status(repository('Museum')) - -} -} -\author{ -Marcin Kosinski, \email{m.p.kosinski@gmail.com} -} -\seealso{ -Other archivist: \code{\link{Repository}}, - \code{\link{Tags}}, \code{\link{\%a\%}}, - \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, - \code{\link{aformat}}, \code{\link{ahistory}}, - \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, - \code{\link{archivist-package}}, \code{\link{aread}}, - \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, - \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, - \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, - \code{\link{searchInLocalRepo}}, - \code{\link{setLocalRepo}}, - \code{\link{shinySearchInLocalRepo}}, - \code{\link{showLocalRepo}}, - \code{\link{splitTagsLocal}}, - \code{\link{summaryLocalRepo}}, - \code{\link{zipLocalRepo}} -} - diff --git a/man/rmFromRepo.Rd b/man/rmFromRepo.Rd index 5ddc0a7..de94bd5 100644 --- a/man/rmFromRepo.Rd +++ b/man/rmFromRepo.Rd @@ -323,17 +323,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{saveToRepo}}, + \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/saveToRepo.Rd b/man/saveToRepo.Rd index 6f274d7..1003fef 100644 --- a/man/saveToRepo.Rd +++ b/man/saveToRepo.Rd @@ -7,7 +7,8 @@ saveToRepo(artifact, repoDir = NULL, archiveData = TRUE, archiveTags = TRUE, archiveMiniature = TRUE, archiveSessionInfo = TRUE, force = TRUE, rememberName = TRUE, value = FALSE, ..., userTags = c(), - silent = aoptions("silent"), ascii = FALSE) + silent = aoptions("silent"), ascii = FALSE, + artifactName = deparse(substitute(artifact))) } \arguments{ \item{artifact}{An arbitrary R artifact to be saved. For supported artifacts see details.} @@ -40,6 +41,8 @@ Further arguments passed to \link{head}. See Details section about \code{firtsRo \item{silent}{If TRUE produces no warnings.} \item{ascii}{A logical value. An \code{ascii} argument is passed to \link{save} function.} + +\item{artifactName}{The name of the artifact with which it should be archived.} } \value{ As a result of calling this function a character string is returned, which determines @@ -287,17 +290,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, + \code{\link{rmFromRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/searchInRepo.Rd b/man/searchInRepo.Rd index aed8c49..9279a8d 100644 --- a/man/searchInRepo.Rd +++ b/man/searchInRepo.Rd @@ -212,18 +212,16 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, \code{\link{setLocalRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, + \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, \code{\link{showLocalRepo}}, \code{\link{splitTagsLocal}}, diff --git a/man/setRepo.Rd b/man/setRepo.Rd index adfcf29..950127c 100644 --- a/man/setRepo.Rd +++ b/man/setRepo.Rd @@ -125,18 +125,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, \code{\link{showLocalRepo}}, @@ -149,18 +146,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, \code{\link{showLocalRepo}}, diff --git a/man/shinySearchInRepo.Rd b/man/shinySearchInRepo.Rd index 466d809..8a05b6c 100644 --- a/man/shinySearchInRepo.Rd +++ b/man/shinySearchInRepo.Rd @@ -60,18 +60,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{showLocalRepo}}, \code{\link{splitTagsLocal}}, diff --git a/man/showRepo.Rd b/man/showRepo.Rd index 5535ede..e9f6e3c 100644 --- a/man/showRepo.Rd +++ b/man/showRepo.Rd @@ -208,18 +208,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/splitTags.Rd b/man/splitTags.Rd index 55bb610..160c20c 100644 --- a/man/splitTags.Rd +++ b/man/splitTags.Rd @@ -102,18 +102,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/summaryRepo.Rd b/man/summaryRepo.Rd index 6c8df57..6e00e40 100644 --- a/man/summaryRepo.Rd +++ b/man/summaryRepo.Rd @@ -150,18 +150,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, diff --git a/man/zipRepo.Rd b/man/zipRepo.Rd index 7804ac7..d72705c 100644 --- a/man/zipRepo.Rd +++ b/man/zipRepo.Rd @@ -107,18 +107,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}}, @@ -131,18 +128,15 @@ Other archivist: \code{\link{Repository}}, \code{\link{addHooksToPrint}}, \code{\link{addTagsRepo}}, \code{\link{aformat}}, \code{\link{ahistory}}, \code{\link{alink}}, \code{\link{aoptions}}, - \code{\link{archive}}, - \code{\link{archivist-github-integration}}, \code{\link{archivist-package}}, \code{\link{aread}}, \code{\link{asearch}}, \code{\link{asession}}, - \code{\link{cache}}, \code{\link{cloneGithubRepo}}, - \code{\link{copyLocalRepo}}, - \code{\link{createEmptyRepo}}, - \code{\link{createMDGallery}}, \code{\link{deleteRepo}}, + \code{\link{cache}}, \code{\link{copyLocalRepo}}, + \code{\link{createEmptyLocalRepo}}, + \code{\link{createMDGallery}}, + \code{\link{deleteLocalRepo}}, \code{\link{getRemoteHook}}, \code{\link{getTagsLocal}}, \code{\link{loadFromLocalRepo}}, \code{\link{md5hash}}, - \code{\link{pushRepo}}, \code{\link{rmFromRepo}}, - \code{\link{saveToRepo}}, + \code{\link{rmFromRepo}}, \code{\link{saveToRepo}}, \code{\link{searchInLocalRepo}}, \code{\link{setLocalRepo}}, \code{\link{shinySearchInLocalRepo}},