summary: Repository summary statistics

View source: R/summary.R

summaryR Documentation

Repository summary statistics

Description

summary() provides numerical summaries of catalog content

Usage

summary(
  filters = NULL,
  type = c("overview", "fileTypeSummaries", "cellCountSummaries", "organTypes", "list"),
  catalog = NULL
)

Arguments

filters

filter object created by filters(), or NULL (default; all projects).

type

character(1) type of summary to return. Possible values include "overview", "fileTypeSummaries", "cellCountSummaries", "organType", and a "list" off all summary statistics.

catalog

character(1) source of data. Use catalogs() for possible values.

Value

summary() returns a tibble or (for type = "list") a list-of-lists of summary statistics.

Examples

summary()

filter <- filters(
    organ = list(is = c("brain", "heart")),
    genusSpecies = list(is = "Homo sapiens")
)
summary(filter)
summary(filter, "fileTypeSummaries")
summary(filter, "cellCountSummaries")


Bioconductor/hca documentation built on July 28, 2022, 6:04 p.m.