facet_by: Specify a field to facet by

Description Usage Arguments

View source: R/query_facet.R

Description

Specify a field to facet by

Usage

1
2
3
4
5
6
7
8
facet_by(
  query,
  field,
  limit = -1,
  sort = c("count", "index"),
  mincount = 0,
  offset = 0
)

Arguments

query

a query_facet() object

field

field name or vector of two field names (see facetable_fields() for all possibilities)

limit

Controls how many constraints should be returned for each facet.

sort

Controls how faceted results are sorted.

mincount

Specifies the minimum counts required for a facet field to be included in the response.

offset

Specifies an offset into the facet results at which to begin displaying facets.


hafen/finderquery documentation built on March 24, 2021, 4:44 p.m.