sample_tags {CytobankAPI}

Sample Tag Endpoints

Description

Interact with sample tag endpoints. Download and upload sample tags to save time during the annotation process. Learn more about sample tags here.

Usage

## S4 method for signature 'UserSession'
sample_tags.download(
  UserSession,
  experiment_id,
  directory = getwd(),
  timeout = UserSession@short_timeout
)

## S4 method for signature 'UserSession'
sample_tags.upload(
  UserSession,
  experiment_id,
  file_path,
  timeout = UserSession@long_timeout
)

Arguments

UserSession

Cytobank UserSession object

experiment_id

integer representing an experiment ID

directory

character representing a specific directory to which the file will be downloaded (optional ending directory slash), if left empty, the default will be the current working directory [optional]

timeout

integer representing the request timeout time in seconds

file_path

character representing a file path

Details

sample_tags.download Download the sample tags from an experiment.

sample_tags.upload Upload sample tag annotation data TSV to an experiment.

Examples

## Not run: # Authenticate via username/password
cyto_session <- authenticate(site="premium", username="cyril_cytometry", password="cytobank_rocks!")
# Authenticate via auth_token
cyto_session <- authenticate(site="premium", auth_token="my_secret_auth_token")

## End(Not run)
## Not run: # Download the experiment sample tags TSV to the current working directory
sample_tags.download(cyto_session, 22)

# Download the experiment sample tags TSV to a new directory
sample_tags.download(cyto_session, 22, directory="/my/new/download/directory/")

## End(Not run)
## Not run: sample_tags.upload(cyto_session, 22, file_path="/path/to/my_annotations.tsv")