Copyright | (c) 2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.
See: API Reference for genomics.readgroupsets.coveragebuckets.list
.
- type ReadGroupSetsCoverageBucketsListResource = "v1" :> ("readgroupsets" :> (Capture "readGroupSetId" Text :> ("coveragebuckets" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "start" (Textual Int64) :> (QueryParam "uploadType" Text :> (QueryParam "targetBucketWidth" (Textual Int64) :> (QueryParam "referenceName" Text :> (QueryParam "bearer_token" Text :> (QueryParam "end" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` ListCoverageBucketsResponse)))))))))))))))))
- readGroupSetsCoverageBucketsList :: Text -> ReadGroupSetsCoverageBucketsList
- data ReadGroupSetsCoverageBucketsList
- rgscblXgafv :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)
- rgscblReadGroupSetId :: Lens' ReadGroupSetsCoverageBucketsList Text
- rgscblUploadProtocol :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)
- rgscblPp :: Lens' ReadGroupSetsCoverageBucketsList Bool
- rgscblAccessToken :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)
- rgscblStart :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Int64)
- rgscblUploadType :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)
- rgscblTargetBucketWidth :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Int64)
- rgscblReferenceName :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)
- rgscblBearerToken :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)
- rgscblEnd :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Int64)
- rgscblPageToken :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)
- rgscblPageSize :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Int32)
- rgscblCallback :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)
REST Resource
type ReadGroupSetsCoverageBucketsListResource = "v1" :> ("readgroupsets" :> (Capture "readGroupSetId" Text :> ("coveragebuckets" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "start" (Textual Int64) :> (QueryParam "uploadType" Text :> (QueryParam "targetBucketWidth" (Textual Int64) :> (QueryParam "referenceName" Text :> (QueryParam "bearer_token" Text :> (QueryParam "end" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` ListCoverageBucketsResponse))))))))))))))))) Source
A resource alias for genomics.readgroupsets.coveragebuckets.list
method which the
ReadGroupSetsCoverageBucketsList
request conforms to.
Creating a Request
readGroupSetsCoverageBucketsList Source
Creates a value of ReadGroupSetsCoverageBucketsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ReadGroupSetsCoverageBucketsList Source
Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.
See: readGroupSetsCoverageBucketsList
smart constructor.
Request Lenses
rgscblXgafv :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text) Source
V1 error format.
rgscblReadGroupSetId :: Lens' ReadGroupSetsCoverageBucketsList Text Source
Required. The ID of the read group set over which coverage is requested.
rgscblUploadProtocol :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
rgscblPp :: Lens' ReadGroupSetsCoverageBucketsList Bool Source
Pretty-print response.
rgscblAccessToken :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text) Source
OAuth access token.
rgscblStart :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Int64) Source
The start position of the range on the reference, 0-based inclusive. If specified, `referenceName` must also be specified. Defaults to 0.
rgscblUploadType :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text) Source
Legacy upload protocol for media (e.g. "media", "multipart").
rgscblTargetBucketWidth :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Int64) Source
The desired width of each reported coverage bucket in base pairs. This will be rounded down to the nearest precomputed bucket width; the value of which is returned as `bucketWidth` in the response. Defaults to infinity (each bucket spans an entire reference sequence) or the length of the target range, if specified. The smallest precomputed `bucketWidth` is currently 2048 base pairs; this is subject to change.
rgscblReferenceName :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text) Source
The name of the reference to query, within the reference set associated with this query. Optional.
rgscblBearerToken :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text) Source
OAuth bearer token.
rgscblEnd :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Int64) Source
The end position of the range on the reference, 0-based exclusive. If specified, `referenceName` must also be specified. If unset or 0, defaults to the length of the reference.
rgscblPageToken :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text) Source
The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of `nextPageToken` from the previous response.
rgscblPageSize :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Int32) Source
The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 2048.