intercell_consensus_filter: Quality filter for intercell annotations

View source: R/intercell.R

intercell_consensus_filterR Documentation

Quality filter for intercell annotations

Description

Quality filter for intercell annotations

Usage

intercell_consensus_filter(
  data,
  percentile = NULL,
  loc_percentile = NULL,
  topology = NULL
)

Arguments

data

A data frame with intercell annotations, as provided by intercell.

percentile

Numeric: a percentile cut off for the consensus score of composite categories. The consensus score is the number of resources supporting the classification of an entity into a category based on combined information of many resources. Here you can apply a cut-off, keeping only the annotations supported by a higher number of resources than a certain percentile of each category. If NULL no filtering will be performed. The value is either in the 0-1 range, or will be divided by 100 if greater than 1. The percentiles will be calculated against the generic composite categories and then will be applied to their resource specific annotations and specific child categories.

loc_percentile

Numeric: similar to percentile for major localizations. For example, with a value of 50, the secreted, plasma membrane transmembrane or peripheral attributes will be TRUE only where at least 50 percent of the resources support these.

topology

Character vector: list of allowed topologies, possible values are *"secreted"*, *"plasma_membrane_peripheral"* and *"plasma_membrane_transmembrane"*.

Value

The data frame in data filtered by the consensus scores.

See Also

  • resources

  • intercell

  • filter_intercell

  • intercell_categories

  • intercell_generic_categories

  • intercell_resources

  • intercell_summary

  • intercell_network

Examples

ligand_receptor <- intercell(parent = c("ligand", "receptor"))
nrow(ligand_receptor)
# [1] 50174
lr_q50 <- intercell_consensus_filter(ligand_receptor, 50)
nrow(lr_q50)
# [1] 42863


saezlab/OmnipathR documentation built on Nov. 10, 2024, 11:02 p.m.