ws_list¶
Current list of variants
Synopsis¶
ws_list
Arguments:
ds: dataset name
filter: optional name of applying filter
- conditions: optional list of applying
condition descriptors in JSON string representation
zone: optional :
[list of zone settings[[0]: zone name, string[1]:[variants], list of strings[2]: false, add it if negation of condition is required], ...]in JSON string representationReturn value:
{dictionary"ds": dataset name, string"total-counts":[list[0]: total count of DNA variants, int[1]: total count of transcript variants, int][2]: total count of transcripts, int]"filtered-counts":[list[0]: filtered count of DNA variants, int[1]: filtered count of transcript variants, int][2]: total count of transcripts, int]"active-samples": active samples indexes, string}
Description¶
The request is the principal one for organizing full variant of Viewing regimes.
The request affects only workspaces and return list of :term:variant` record descriptors.
If arguments filter, conditions, zone are not set, result of request is the complete list of records in dataset returns. Otherwise result is restricted by filter and/or condition on zones.
In zone list conditions can be present in positive or negative variants. For negation of condition just add false to the end of instruction.
To define filter use either filter or conditions. See details here.
Some samples can be active in context of current filter, and this information forms property active-samples of descriptor. The string has form of list of integers separated by ',' and can be used as argument of reccnt call.
Comment¶
The request format supports applying of multiple zones, butthe current user interface allows to set only one zone at time. Extension of the user interface is expected in future development.