Get Read Set Metadata

omics_get_read_set_metadata

R Documentation

Gets details about a read set

Description

Gets details about a read set.

Usage

omics_get_read_set_metadata(id, sequenceStoreId)

Arguments

id

[required] The read set's ID.

sequenceStoreId

[required] The read set's sequence store ID.

Value

A list with the following syntax:

list(
  id = "string",
  arn = "string",
  sequenceStoreId = "string",
  subjectId = "string",
  sampleId = "string",
  status = "ARCHIVED"|"ACTIVATING"|"ACTIVE"|"DELETING"|"DELETED"|"PROCESSING_UPLOAD"|"UPLOAD_FAILED",
  name = "string",
  description = "string",
  fileType = "FASTQ"|"BAM"|"CRAM"|"UBAM",
  creationTime = as.POSIXct(
    "2015-01-01"
  ),
  sequenceInformation = list(
    totalReadCount = 123,
    totalBaseCount = 123,
    generatedFrom = "string",
    alignment = "string"
  ),
  referenceArn = "string",
  files = list(
    source1 = list(
      totalParts = 123,
      partSize = 123,
      contentLength = 123,
      s3Access = list(
        s3Uri = "string"
      )
    ),
    source2 = list(
      totalParts = 123,
      partSize = 123,
      contentLength = 123,
      s3Access = list(
        s3Uri = "string"
      )
    ),
    index = list(
      totalParts = 123,
      partSize = 123,
      contentLength = 123,
      s3Access = list(
        s3Uri = "string"
      )
    )
  ),
  statusMessage = "string",
  creationType = "IMPORT"|"UPLOAD",
  etag = list(
    algorithm = "FASTQ_MD5up"|"BAM_MD5up"|"CRAM_MD5up"|"FASTQ_SHA256up"|"BAM_SHA256up"|"CRAM_SHA256up"|"FASTQ_SHA512up"|"BAM_SHA512up"|"CRAM_SHA512up",
    source1 = "string",
    source2 = "string"
  ),
  creationJobId = "string"
)

Request syntax

svc$get_read_set_metadata(
  id = "string",
  sequenceStoreId = "string"
)