Add an OSF node as a destination — projr_yml_dest_add

Add an OSF node (project or component) as a destination to a _projr.yml file.

Usage

projr_yml_dest_add_osf(
  title,
  content,
  path = NULL,
  structure = NULL,
  path_append_label = NULL,
  overwrite = FALSE,
  public = FALSE,
  category = NULL,
  description = NULL,
  id = NULL,
  id_parent = NULL,
  send_cue = NULL,
  send_sync_approach = NULL,
  send_version_source = NULL,
  send_conflict = NULL,
  profile = "default"
)

projr_yml_dest_add_osf_proj(
  title,
  description = NULL,
  content = NULL,
  public = FALSE,
  id = NULL
)

projr_yml_dest_add_osf_comp(
  title,
  description = NULL,
  content = NULL,
  public = FALSE,
  category = NULL,
  id_parent = NULL,
  id = NULL
)

Arguments

title: character. Title of the OSF node. For GitHub releases, can use title as @version, Note that this implies that a new tag will be created with each new version, so do not use with large files. If not supplied, then will automatically be generated from content.
content: character vector. Labels of directories to include in the upload. Options are the labels of directories in the active projr configuration, as well as "docs", "data" and "code". "docs" means the directory where the documents are rendered to, "data" means the files in the "data" directory, and "code" means all files tracked by the Git repository.
path: character. Path to the directory on the OSF node.
structure: "latest" or "version". Structure of the remote. If "latest", then path simply contains the latest versions of the contents. If "version", then path will contain a directory for each version. If not supplied, will be version.
path_append_label: logical. Whether to append the label to the path. If TRUE, then the label will be appended to path. If FALSE, then the path will be the path to the label. If not set, then will be treated as TRUE.
overwrite: logical. Whether to rewrite an existing entry of the same title in the specified projr configuration file. Default is TRUE.
public: logical. Whether the OSF node is public. Default is FALSE.
category: character. The category of the project or component. The following are valid options: "project", "analysis", "communication", "data", "hypothesis", "instrumentation", "methods and measures", "procedure", "project", "software" and other "other". Default is NULL.
description: character. Description of the OSF node. Default is NULL.
id: character. The id of the project or component. Must be five characters. Default is NULL.
id_parent: character. The id of the parent project or component. Must be five characters. Default is NULL.
send_cue: TRUE/FALSE, or one of "build", "dev", "patch", "minor" or "major". Minimum component bumped in a project build to initiate the upload. If TRUE, then will be set to "patch". If FALSE, then will never be uploaded. If "build", then will be uploaded on every build, including dev builds, so dev and "build" are equivalent.
send_sync_approach: "upload-all", "upload-missing", "sync-using-deletiong" and "sync-using-version". How to synchronise to the remote. If upload-all, then all files are uploaded. If upload-missing, then only missing files are uploaded. If sync-using-deletion, then all files on the remote are deleted before uploading all local files. If sync-using-version, then files that have changed or been added locally are uploaded to the remote, and files that have been removed locally are removed from the remote. If not set, then "sync-using-version" will be used.
send_version_source: "manifest" or "file". For sync-using-version synchronisation approach, whether to use the recorded versions of objects to determine what has changed ("manifest"), or to download everything from the remote, version it and compare it to what's in the local folder ("file"). If not set, then "manifest" is used.
send_conflict: "overwrite", "error" or "skip". What to do if a file that is to be uploaded to the remote is already on the remote. Default is "overwrite".
profile: character. Profile to write the settings to. If "default", then written to _projr.yml, otherwise written to _projr-<profile>.yml. The default is "default".