meta_rels_list_rel: List relationships under a meta relationship

View source: R/meta.R

meta_rels_list_relR Documentation

List relationships under a meta relationship

Description

GET /meta/rels/{meta_rel}/list

Usage

meta_rels_list_rel(meta_rel, limit = 10, offset = 0, mode = c("table", "raw"))

Arguments

meta_rel

Name of a meta relationship (e.g. MR). Use meta_rels_list to get the full list of meta relationships.

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/rels/{meta_rel}/list

Examples

# List the first 5 MR relationships
## Not run: 
meta_rels_list_rel(meta_rel = "MR_EVE_MR", limit = 5)

## End(Not run)

MRCIEU/epigraphdb-r documentation built on Aug. 29, 2022, 4:05 a.m.