gogol-genomics-0.0.1: Google Genomics SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Genomics.Reads.Search

Contents

Description

Gets a list of reads for one or more read group sets. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested read group sets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (reference sequence & position). Reads with equivalent genomic coordinates are returned in a deterministic order. Implements GlobalAllianceApi.searchReads.

See: API Reference for genomics.reads.search.

Synopsis

REST Resource

type ReadsSearchResource = "v1" :> ("reads" :> ("search" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` SearchReadsRequest :> Post `[JSON]` SearchReadsResponse))))))))))) Source

A resource alias for genomics.reads.search method which the ReadsSearch request conforms to.

Creating a Request

readsSearch Source

Creates a value of ReadsSearch with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ReadsSearch Source

Gets a list of reads for one or more read group sets. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested read group sets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (reference sequence & position). Reads with equivalent genomic coordinates are returned in a deterministic order. Implements GlobalAllianceApi.searchReads.

See: readsSearch smart constructor.

Request Lenses

reaXgafv :: Lens' ReadsSearch (Maybe Text) Source

V1 error format.

reaUploadProtocol :: Lens' ReadsSearch (Maybe Text) Source

Upload protocol for media (e.g. "raw", "multipart").

reaPp :: Lens' ReadsSearch Bool Source

Pretty-print response.

reaUploadType :: Lens' ReadsSearch (Maybe Text) Source

Legacy upload protocol for media (e.g. "media", "multipart").

reaPayload :: Lens' ReadsSearch SearchReadsRequest Source

Multipart request metadata.