Need to return more complex object to support counting hits and facets

[seandavi]

See #16 for details on facets and the need for this proposed change.

Currently, the API calls return only the "hits" data. To support counting of results (in the pagination JSON object) and facets (in the aggregation JSON object), we need to return a more complicated object. I am proposing that we return a list with three elements:

• results -- contains the current gdc_list representation
• facets -- if facets specified, this will be a list of data.frames, one for each facet field
• pages -- gives counts, page size, and pages

[seandavi]

Also, see #15.

[lawremi]

Assuming this is happening at a fairly low level, probably should at least slap a class on the list for integrity reasons. See ListSolrResult.

[seandavi]

That is the thinking. Thanks.

On Jan 7, 2017 2:10 PM, "Michael Lawrence" notifications@github.com wrote:

Assuming this is happening at a fairly low level, probably should at least slap a class on the list for integrity reasons. See ListSolrResult.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/Bioconductor/GenomicDataCommons/issues/26#issuecomment-271103438, or mute the thread https://github.com/notifications/unsubscribe-auth/AAFpEyJhiD5yUZ2sY0R5GTxBhHYMlL_xks5rP-M9gaJpZM4LdfDv .

[seandavi]

first-pass at complex object complete. See GDCResponse. Incorporated into tag 0.4.0.