searchStudy: Search study in AntaREST

View source: R/API.R

searchStudyR Documentation

Search study in AntaREST

Description

Search study in AntaREST

Usage

searchStudy(
  workspace = NULL,
  folder = NULL,
  name = NULL,
  ...,
  host = NULL,
  token = NULL
)

Arguments

workspace

Space in which to search for a study.

folder

Folder in which to search for a study.

name

Name for the study.

...

Other query parameters.

host

Host of AntaREST server API.

token

API personnal access token.

Value

a data.table with informations about studies on the server.

Examples

## Not run: 

searchStudies(host = "http://localhost:8080")


## End(Not run)

antaresEditObject documentation built on Oct. 4, 2023, 1:06 a.m.