Class: AssociationLZ

LocusZoom_Adapters~AssociationLZ()

Retrieve Association Data from the LocusZoom/ Portaldev API (or compatible). Defines how to make a request to a specific REST API.

Constructor

new AssociationLZ()

Parameters:
Name Type Description
config.url string

The base URL for the remote data.

config.params object
Properties
Name Type Attributes Default Description
sort <optional>
false

Whether to sort the association data (by an assumed field named "position"). This is primarily a site-specific workaround for a particular LZ usage; we encourage apis to sort by position before returning data to the browser.

source <optional>

The ID of the GWAS dataset to use for this request, as matching the API backend

Source:
See:

Methods

getURL()

Add query parameters to the URL to construct a query for the specified region

Source:

(protected) normalizeResponse(data) → {Object}

Some association sources do not sort their data in a predictable order, which makes it hard to reliably align with other sources (such as LD). For performance reasons, sorting is an opt-in argument. TODO: Consider more fine grained sorting control in the future. This was added as a very specific workaround for the original T2D portal.

Parameters:
Name Type Description
data
Source:
Returns:
Type
Object