GitHub Repository tools - file functions

• repo_add_file - Add / update files in a GitHub repository. Note that due to time delays in caching, files that have been added very recently might not yet be displayed as existing and might accidentally be overwritten.

• repo_delete_file - Delete a file from a Github repository

• repo_modify_file - Modify an existing file within a GitHub repository.

• repo_ls - Low level function for listing the files in a GitHub Repository

• repo_put_file - Low level function for adding a file to a Github repository

• repo_get_file - Low level function for retrieving the content of a file from a GitHub Repository

• repo_get_readme - Low level function for retrieving the content of the README.md of a GitHub Repository

repo_add_file(
  repo,
  file,
  message = NULL,
  repo_folder = NULL,
  branch = "master",
  preserve_path = FALSE,
  overwrite = FALSE
)

repo_delete_file(repo, path, message = NULL, branch = "master")

repo_get_file(
  repo,
  path,
  branch = "master",
  quiet = FALSE,
  include_details = TRUE
)

repo_get_readme(repo, branch = "master", include_details = TRUE)

repo_ls(repo, path = ".", branch = "master", full_path = FALSE)

repo_modify_file(
  repo,
  path,
  pattern,
  content,
  method = c("replace", "before", "after"),
  all = FALSE,
  message = "Modified content",
  branch = "master"
)

repo_put_file(
  repo,
  path,
  content,
  message = NULL,
  branch = "master",
  verbose = TRUE
)

Arguments

repo	Character. Address of repository in owner/name format.
file	Character. Local file path(s) of file or files to be added.
message	Character. Commit message.
repo_folder	Character. Name of folder on repository to save the file(s) to. If the folder does not exist on the repository, it will be created.
branch	Character. Name of branch to use, defaults to "master".
preserve_path	Logical. Should the local relative path be preserved.
overwrite	Logical. Should existing file or files with same name be overwritten, defaults to FALSE.
path	Character. File's path within the repository.
quiet	Logical. Should status messages be printed.
include_details	Logical. Should file details be attached as attributes.
full_path	Logical. Should the function return the full path of the files and directories.
pattern	Character. Regex pattern.
content	Character or raw. Content of the file.
method	Character. Should the content replace the matched pattern or be inserted before or after the match.
all	Character. Should all instances of the pattern be modified (TRUE) or just the first (FALSE).
verbose	Logical. Should success / failure messages be printed

Examples

if (FALSE) {
repo = repo_create("ghclass-test", "repo_file_test", auto_init=TRUE)

repo_ls(repo, path = ".")

repo_get_readme(repo, include_details = FALSE)

repo_get_file(repo, ".gitignore", include_details = FALSE)

repo_modify_file(
  repo, path = "README.md", pattern = "repo_file_test",
  content = "\n\nHello world!\n", method = "after"
)

repo_get_readme(repo, include_details = FALSE)

repo_add_file(repo, file = system.file("DESCRIPTION", package="ghclass"))

repo_get_file(repo, "DESCRIPTION", include_details = FALSE)

repo_delete_file(repo, "DESCRIPTION")

repo_delete(repo, prompt=FALSE)
}