epigraphdb (version 0.2.3)

meta_nodes_list_node: List nodes under a meta node

Description

GET /meta/nodes/{meta_node}/list

Usage

meta_nodes_list_node(
  meta_node,
  full_data = TRUE,
  limit = 10,
  offset = 0,
  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.

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.

limit

Max number of items to retrieve.

offset

Number of items to skip. Use limit and offset in combination to do pagination.

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}/list

Examples

# NOT RUN {
# List the first 5 Gwas nodes, with only id and name fields
# }
# NOT RUN {
meta_nodes_list_node(meta_node = "Gwas", full_data = FALSE, limit = 5)
# }
# NOT RUN {
# List the 6th - 10th Disease nodes, with full properties
# }
# NOT RUN {
meta_nodes_list_node(meta_node = "Disease", full_data = TRUE, limit = 5, offset = 0)
# }