federation_facet: Federation facets

In ropensci/rif: Client for 'Neuroscience' Information Framework 'APIs'

Federation facets

Description

Federation facets

Usage

federation_facet(
  id,
  query = NULL,
  strict = FALSE,
  subclassQuery = NULL,
  expandSynonyms = TRUE,
  expandAcronyms = FALSE,
  expandAbbrevs = FALSE,
  expandInferred = TRUE,
  offset = 0,
  count = 20,
  minCount = 2,
  facet = NULL,
  filter = NULL,
  orMultiFacets = FALSE,
  subclassFilters = NULL,
  key = NULL,
  ...
)

Arguments

id	(character) A dataset id
query	Query terms
strict	(logical) Only consider more relevant columns. Default: FALSE
subclassQuery	(character) An known ID to query with subclass axiom entailment (include all subclasses in the search). This can be combined with the "query" parameter.
expandSynonyms	(logical) Should recognized terms in the query have synonyms expanded? Default: TRUE
expandAcronyms	(logical) Default: FALSE
expandAbbrevs	(logical) Default: FALSE
expandInferred	(logical) Should recognized terms in the query have inferred terms expanded? Default: TRUE
offset	(integer) The result (row) to start on query 0
count	(integer) The number of results (rows) to return. Default: 20
minCount	(integer) The minimum count result to return. Default: 2
facet	(character) Facets specified like facetName:facetValue query
filter	(character) Filters specified like columnName:filterValue. If the column is declared numeric then the filterValue can be a range expression (ie: >24.3)
orMultiFacets	(logical) True if multiple facet values for the same facet are specified in the query and should be ORed together. Defaults to "AND"
subclassFilters	(character) Filter specified like columnName:parentId where parentId is a known ID. All subclasses of parentID will be included in the filter. This parameter may be combined with "filter".
key	(character) API key. required either passed in here or save as an env var or R option. see rif and Startup
...	Curl options passed on to HttpClient

See Also

Other federation: federation_data(), federation_search()

Examples

## Not run: 
out <- federation_facet(id = "nlx_152871-2")
out$category
out$facets

out <- federation_facet(id = "nlx_152871-2", count = 100)
out$category
out$facets

federation_facet(id = "nlx_152871-2", count = 100, minCount = 10)

## End(Not run)

ropensci/rif documentation built on May 18, 2022, 6:40 p.m.