federation_data: Federation data

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

Federation data

Description

Federation data

Usage

federation_data(
  id,
  query = NULL,
  strict = FALSE,
  subclassQuery = NULL,
  expandSynonyms = TRUE,
  expandAcronyms = FALSE,
  expandAbbrevs = FALSE,
  expandInferred = TRUE,
  highlight = FALSE,
  sortField = NULL,
  sortAsc = TRUE,
  offset = 0,
  count = 20,
  project = NULL,
  facet = NULL,
  filter = NULL,
  subclassFilter = NULL,
  includePrimaryData = FALSE,
  exportType = NULL,
  orMultiFacets = FALSE,
  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
highlight	(logical) Highlight ...
sortField	(character) The field to sort by
sortAsc	(logical) Sort ascending?
offset	(integer) The result (row) to start on
count	(integer) The number of results (rows) to return
project	(character) The columns to project (all by default)
facet	(character) Facets specified like facetName:facetValue
filter	(character) Filters specified like columnName:filterValue. If the column is declared numeric then the filterValue can be a range expression (ie: >24.3).
subclassFilter	(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".
includePrimaryData	(logical) deprecated Should primary data be included in addition to the view? Please use the exportType option instead.
exportType	(character) The type of data to return: "display" (data suitable for a user interface - includes HTML), "data" (just the raw data used to include the view - may include more data than present in the view but will not include markup) "all" (include both display and data columns)
orMultiFacets	(logical) True if multiple facet values for the same facet are specified in the query and should be ORed together. Defaults to "AND"
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_facet(), federation_search()

Examples

## Not run: 
out <- federation_data(id = "nlx_152871-2")
out$query
out$messages
out$result$resultCount
out$result$nifId
out$result$debugInfo
out$result$result
out$result$results

federation_data(id = "nlx_152871-2", query = "TS23")

federation_data("nlx_152871-2", verbose = TRUE)

## End(Not run)

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