ConceptLibraryClient: ConceptLibraryClient: A Concept Library API Client

In SwanseaUniversityMedical/ConceptLibraryClient: Concept Library API Client

ConceptLibraryClient: A Concept Library API Client

Description

This package acts as a client for the ConceptLibrary API

Authenticated API connection

By calling ConceptLibraryClient::Connection$new(), the user must provide login credentials either in the function itself, or in the popup window if none are given.

Non-authenticated API connection

A non-authenticated, or public, connection can be made to the ConceptLibrary by calling ConceptLibraryClient::Connection$new(public=TRUE).

Modifying API connection URL

The connection function also provides a url parameter to specify a different URL to send the API requests to.

We provide default connection urls through: ConceptLibraryClient::DOMAINS

Making API requests

The following functions can be used to retrieve the various types of data stored in the Concept Library.

Phenotypes

• client$phenotypes$get

• client$phenotypes$get_versions

• client$phenotypes$get_detail

• client$phenotypes$get_codelist

• client$phenotypes$save_definition_file

• client$phenotypes$create

• client$phenotypes$update

Concepts

• client$concepts$get

• client$concepts$get_versions

• client$concepts$get_detail

• client$concepts$get_codelist

Templates

• client$templates$get

• client$templates$get_versions

• client$templates$get_detail

Collections

• client$templates$get

• client$templates$get_detail

Tags

• client$templates$get

• client$templates$get_detail

Datasources

• client$templates$get

• client$templates$get_detail

Author(s)

Maintainer: Dan Thayer [e-mail]

Authors:

• Etienne Badoche [e-mail]

• Ieuan Scanlon [e-mail]

• Jack Scanlon [e-mail]

SwanseaUniversityMedical/ConceptLibraryClient documentation built on April 14, 2025, 12:45 p.m.