HCAMatrix: API Entry function for the Human Cell Atlas Matrix service

Description Usage Arguments Value Filters Formats Features Examples

View source: R/HCAMatrix.R

Description

This function allows the use of the HCA Matrix API

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
HCAMatrix()

available_filters(api)

filter_detail(api, filter_name)

available_formats(api)

format_detail(api, format_name)

available_features(api)

feature_detail(api, feature_name)

Arguments

api

An HCAMatrix API object

filter_name

character(1) The name of the filter to get more detail on

format_name

character(1) The format for which to obtain more detail on

feature_name

character(1) The feature for which to obtain more detail on

Value

An object of class 'HCAMatrix'

Filters

* available_filter - Get a list of filters within the API to filter with * filter_detail - Obtain more detail on a particular filter name

Formats

* available_formats - Get a list of matrix format outputs * format_detail - Obtain more detail on a particular matrix file format

Features

* available_features - Get a list of feature outputs, either genes or transcripts * feature_detail - Obtain more information on a matrix feature type

Examples

1
hca <- HCAMatrix()

HCAMatrixBrowser documentation built on Nov. 8, 2020, 5:15 p.m.