RSuite (version 0.37-253)

repo_adapter_get_info: Returns information about repository the adapter is working on.

Description

Returns information about repository the adapter is working on.

Usage

repo_adapter_get_info(repo_adapter, params)

Arguments

repo_adapter

repo adapter object

params

rsuite_project_params object

Value

named list with following entries:

readonly

TRUE if the repository is for reading only (type:logical)

reliable

TRUE if the content of the repository does not change over time unless repository changes enforce changes of the project itself (like project local repository) (type: logical).

See Also

Other in extending RSuite with Repo adapter: repo_adapter_create_base, repo_adapter_create_manager, repo_adapter_get_path, repo_manager_destroy, repo_manager_get_info, repo_manager_init, repo_manager_remove, repo_manager_upload

Examples

# NOT RUN {
# create you own Repo adapter
repo_adapter_create_own <- function() {
  result <- repo_adapter_create_base("Own")
  class(result) <- c("repo_adapter_own", class(result))
  return(result)
}

#' @export
repo_adapter_get_info.repo_adapter_own <- function(repo_adapter, params) {
  return(list(
     readonly = TRUE, # cannot be managed
     reliable = FALSE # package versions can change in time
  ))
}

# }