Compose BioCompute Object - SCM Extension (v1.4.2)

Compose BioCompute Object - SCM Extension (v1.4.2)

compose_scm_v1.4.2(
  scm_repository = NULL,
  scm_type = c("git", "svn", "hg", "other"),
  scm_commit = NULL,
  scm_path = NULL,
  scm_preview = NULL
)

compose_scm(
  scm_repository = NULL,
  scm_type = c("git", "svn", "hg", "other"),
  scm_commit = NULL,
  scm_path = NULL,
  scm_preview = NULL
)

Arguments

scm_repository

Character string. Base URL of the SCM repository.

scm_type

Character string. Type of SCM database. Must be one of "git", "svn", "hg", or "other".

scm_commit

Character string. Revision within the SCM repository. Should be a repository-wide commit identifier or name of a tag, but may be a name of a branch.

scm_path

Character string. Path from the repository to the source code referenced. Should not start with /.

scm_preview

Character string. The full URI for the source code referenced by the BioCompute Object.

Value

A list of class bco.domain

Examples

scm_repository <- "https://github.com/example/repo"
scm_type <- "git"
scm_commit <- "c9ffea0b60fa3bcf8e138af7c99ca141a6b8fb21"
scm_path <- "workflow/hive-viral-mutation-detection.cwl"
scm_preview <- "https://github.com/example/repo/blob/master/mutation-detection.cwl"

compose_scm(scm_repository, scm_type, scm_commit, scm_path, scm_preview) %>% convert_json()
#> {
#>   "scm_repository": "https://github.com/example/repo",
#>   "scm_type": "git",
#>   "scm_commit": "c9ffea0b60fa3bcf8e138af7c99ca141a6b8fb21",
#>   "scm_path": "workflow/hive-viral-mutation-detection.cwl",
#>   "scm_preview": "https://github.com/example/repo/blob/master/mutation-detection.cwl"
#> }