README.md

In Bioconductor/hcamatrixapi: R Package Client for HCA Matrix Service

R API client for hcamatrixapi

Human Cell Atlas Matrix Service API

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

• API version: 1.0.0
• Package version: 0.99.0
• Build package: org.openapitools.codegen.languages.RClientCodegen

Installation

Prerequisites

Install the dependencies

install.packages("jsonlite")
install.packages("httr")
install.packages("caTools")

Build the package

git clone https://github.com/GIT_USER_ID/GIT_REPO_ID
cd GIT_REPO_ID
R CMD build .
R CMD check hcamatrixapi_0.99.0.tar.gz
R CMD INSTALL hcamatrixapi_0.99.0.tar.gz

Install the package

install.packages("hcamatrixapi")

To install directly from Github, use devtools:

install.packages("devtools")
library(devtools)
install_github("GIT_USER_ID/GIT_REPO_ID")

Usage

library(hcamatrixapi)

Documentation for API Endpoints

All URIs are relative to https://$

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- V0Api | MatrixLambdasApiV0CoreGetFormats | GET /v0/matrix/formats | Returns supported output formats. V0Api | MatrixLambdasApiV0CoreGetMatrix | GET /v0/matrix/{request_id} | Retrieve the status, and result if available, of a matrix query request. V0Api | MatrixLambdasApiV0CorePostMatrix | POST /v0/matrix | Submit a matrix query request. V1Api | MatrixLambdasApiV1CoreGetFeatureDetail | GET /v1/features/{feature_name} | Get a information about a matrix feature type V1Api | MatrixLambdasApiV1CoreGetFeatures | GET /v1/features | Get a list of available feature types V1Api | MatrixLambdasApiV1CoreGetFieldDetail | GET /v1/fields/{field_name} | Get a description of a metadata field V1Api | MatrixLambdasApiV1CoreGetFields | GET /v1/fields | Get a list of available metadata fields V1Api | MatrixLambdasApiV1CoreGetFilterDetail | GET /v1/filters/{filter_name} | Get a description of a filter V1Api | MatrixLambdasApiV1CoreGetFilters | GET /v1/filters | Get a list of permitted filters V1Api | MatrixLambdasApiV1CoreGetFormatDetail | GET /v1/formats/{format_name} | Get a description of a matrix format V1Api | MatrixLambdasApiV1CoreGetFormats | GET /v1/formats | Get a list of available matrix formats V1Api | MatrixLambdasApiV1CoreGetMatrix | GET /v1/matrix/{request_id} | Get status and result of a matrix request V1Api | MatrixLambdasApiV1CorePostMatrix | POST /v1/matrix | Request an expression matrix

Documentation for Models

• V0MatrixErrorResponse
• V0MatrixFormat
• V0MatrixGetResponse
• V0MatrixPostResponse
• V0MatrixRequest
• V0MatrixRequestStatus
• V1CategoricalFieldDetail
• V1CategoricalFieldDetailAllOf
• V1ComparisonFilter
• V1ComparisonFilterOperator
• V1FieldDetail
• V1LogicalFilter
• V1LogicalFilterOperator
• V1MatrixErrorResponse
• V1MatrixFeatureDetail
• V1MatrixFilter
• V1MatrixGetResponse
• V1MatrixPostResponse
• V1MatrixRequest
• V1NumericFieldDetail
• V1NumericFieldDetailAllOf

Documentation for Authorization

All endpoints do not require authorization.

Author

Bioconductor/hcamatrixapi documentation built on Nov. 6, 2019, 12:10 a.m.