Dataset.query: Dataset.query

In solvebio/solvebio-r: The Official SolveBio API Client

Dataset.query

Description

Queries a SolveBio dataset and returns an R data frame containing all records. Returns a single page of results otherwise (default).

Usage

Dataset.query(
  id,
  paginate = FALSE,
  use_field_titles = TRUE,
  env = solvebio:::.solveEnv,
  ...
)

Arguments

id	The ID of a SolveBio dataset, or a Dataset object.
paginate	When set to TRUE, retrieves all records (memory permitting).
use_field_titles	(optional) Use field title instead of field name for query.
env	(optional) Custom client environment.
...	(optional) Additional query parameters (e.g. filters, limit, offset).

References

https://docs.solvebio.com/

Examples

## Not run: 
Dataset.query("12345678790", paginate=TRUE)

## End(Not run)

solvebio/solvebio-r documentation built on Dec. 8, 2022, 4:29 a.m.