drop: DROP File Endpoints

Description Usage Arguments Details Examples

Description

Upload DROP file(s) into Cytobank. A DROP file consists of any CSV, TSV, TXT, or FCS file. If the DROP file is of the type CSV, TSV, or TXT, the file will be converted to an FCS file to be used within Cytobank. Learn more about DROP.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## S4 method for signature 'UserSession'
drop.upload(
  UserSession,
  experiment_id,
  file_path,
  data_matrix_start_row = 2,
  data_matrix_start_column = 1,
  skipped_columns = c(),
  output = "default",
  timeout = UserSession@long_timeout
)

Arguments

UserSession

Cytobank UserSession object

experiment_id

integer representing an experiment ID

file_path

character representing a file path

data_matrix_start_row

integer representing the start row of the DROP file(s)

data_matrix_start_column

integer representing the start column of the DROP file(s)

skipped_columns

integer vector representing the channels to skip within the DROP file(s)

output

character representing the output format [optional]
- drop.upload : ("default", "raw")
- dataframe: converts the file internal compensation matrix output to a dataframe

timeout

integer representing the request timeout time in seconds [optional]

Details

drop.upload Upload a DROP file (CSV, TSV, TXT, FCS) to an experiment. - Optional output parameter, specify one of the following: ("default", "raw")

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## 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: drop.upload(cyto_session, 22, file_path="/path/to/my_drop_file.type",
  data_matrix_start_row=2, data_matrix_start_column=1, skipped_columns=c(4,8))

## End(Not run)

CytobankAPI documentation built on Oct. 4, 2021, 9:07 a.m.