meta_nodes_search_node: Search a node by its id field, or its name field

Description Usage Arguments Value Examples

View source: R/meta.R

Description

GET /meta/nodes/{meta_node}/search

Usage

1
2
3
4
5
6
7
8
meta_nodes_search_node(
  meta_node,
  id = NULL,
  name = NULL,
  limit = 10,
  full_data = TRUE,
  mode = c("table", "raw")
)

Arguments

meta_node

Name of a meta node (e.g. Gwas). Use meta_nodes_list to get the full list of meta nodes.

id

The id field of a node (e.g. "ieu-a-2" for a Gwas). Use EpiGraphDB web UI to get a sense of what those ids are for entities.

name

The name field of a node (e.g. "body mass index" for a Gwas). Use EpiGraphDB web UI to get a sense of what those names are for entities.

limit

Max number of items to retrieve.

full_data

When False, only return the id and name fields (their specific names differ in specific nodes) for a node. This is useful if you want your queries to return results faster with smaller amount of data requested.

mode

If mode = "table", returns a data frame (a tibble as per tidyverse convention). If mode = "raw", returns a raw response from EpiGraphDB API with minimal parsing done by httr.

Value

Data from GET /meta/nodes/{meta_node}/search

Examples

1
2
# Search Gwas nodes
meta_nodes_search_node(meta_node = "Gwas", name = "body mass index")

epigraphdb documentation built on March 29, 2021, 5:11 p.m.