List Read Sets

omics_list_read_sets

R Documentation

Retrieves a list of read sets

Description

Retrieves a list of read sets.

Usage

omics_list_read_sets(sequenceStoreId, maxResults, nextToken, filter)

Arguments

sequenceStoreId

[required] The jobs' sequence store ID.

maxResults

The maximum number of read sets to return in one page of results.

nextToken

Specify the pagination token from a previous request to retrieve the next page of results.

filter

A filter to apply to the list.

Value

A list with the following syntax:

list(
  nextToken = "string",
  readSets = list(
    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",
      referenceArn = "string",
      fileType = "FASTQ"|"BAM"|"CRAM"|"UBAM",
      sequenceInformation = list(
        totalReadCount = 123,
        totalBaseCount = 123,
        generatedFrom = "string",
        alignment = "string"
      ),
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      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"
      )
    )
  )
)

Request syntax

svc$list_read_sets(
  sequenceStoreId = "string",
  maxResults = 123,
  nextToken = "string",
  filter = list(
    name = "string",
    status = "ARCHIVED"|"ACTIVATING"|"ACTIVE"|"DELETING"|"DELETED"|"PROCESSING_UPLOAD"|"UPLOAD_FAILED",
    referenceArn = "string",
    createdAfter = as.POSIXct(
      "2015-01-01"
    ),
    createdBefore = as.POSIXct(
      "2015-01-01"
    ),
    sampleId = "string",
    subjectId = "string",
    generatedFrom = "string",
    creationType = "IMPORT"|"UPLOAD"
  )
)