Initializes the upload of the specified file

Source: R/api-misc.R

This is the first operation performed when you wish to upload a file. Operation is initialized by providing file name, project id where you wish the file to be uploaded to (if not specified, defaults to user's stash) and optionally by providing wanted part size. You may wish to set your part size to a low value if you experience problems with uploading large file parts, although default value of 5MB should be good enough for most users.

upload_init(
  token = NULL,
  project_id = NULL,
  name = NULL,
  size = NULL,
  part_size = NULL,
  ...
)

Arguments

token

auth token
project_id

ID of the project you wish to upload to
name

Name of the file you wish to upload
size

Size of the file you wish to upload
part_size

Requested part size. Note that API may reject your requested part size and return proper one in response.
...

parameters passed to api function

Value

parsed list of the returned json

Details

Limits:

  • Maximum number of parts is 10000

  • Maximum file size is 5TB

  • Maximum part size is 5GB

  • Default part size is 5MB

Examples

token <- "your_token"
if (FALSE) {
req <- upload_init(
  token,
  project_id = "your_project_id",
  name = "Sample1_RNASeq_chr20.pe_1.fastq", size = 5242880
)}