export_sevenbridges: Export BioCompute Object to Seven Bridges Platforms

In sbg/biocompute: Create and Manipulate BioCompute Objects

Export BioCompute Object to Seven Bridges Platforms

Description

Export BioCompute Object to Seven Bridges Platforms

Usage

export_sevenbridges(
  file,
  name = NULL,
  project = NULL,
  token = NULL,
  base_url = "https://api.sbgenomics.com/v2/",
  overwrite = TRUE
)

Arguments

file	Path to the BCO file.
name	Name of the BCO file to create on the platform. Defaults to the name of the input file.
project	Project to upload (export) the BCO file to. Format: "username/project".
token	API auth token for the platform. Generate the token from the platform's Developer Dashboard.
base_url	API base URL. Get the base URL from the platform's Developer Dashboard.
overwrite	If TRUE, will overwrite the existing BCO file with the same name in that project (if any). If FALSE, will not overwrite.

Value

Response of the file upload request

Examples

## Not run: 
file_json <- tempfile(fileext = ".json")
generate_example("HCV1a") %>%
  convert_json() %>%
  export_json(file_json)

try(
  export_sevenbridges(
    file_json,
    project = "rosalind_franklin/project_name",
    token = "your_api_auth_token",
    base_url = "https://cgc-api.sbgenomics.com/v2/"
  )
)

## End(Not run)

sbg/biocompute documentation built on June 11, 2024, 6:16 a.m.