validateCreateEnrichMapSubSectionArguments: Validate common arguments passed to createEnrichMap() and...

In adeschen/gprofiler2cytoscape: From functional enrichment results to biological networks

Validate common arguments passed to createEnrichMap() and createEnrichMapMultiBasic() functions

Description

Validate the common arguments passed to createEnrichMap() and createEnrichMapMultiBasic() functions.

Usage

validateCreateEnrichMapSubSectionArguments(
  showCategory,
  groupCategory,
  categoryLabel,
  categoryNode,
  line
)

Arguments

showCategory	a positive integer or a vector of characters representing terms. If a integer, the first n terms will be displayed. If vector of terms, the selected terms will be displayed.
groupCategory	a logical indicating if the categories should be grouped.
categoryLabel	a positive numeric representing the amount by which plotting category nodes label size should be scaled relative to the default (1).
categoryNode	a positive numeric representing he amount by which plotting category nodes should be scaled relative to the default (1).
line	a non-negative numeric representing the scale of line width.

Value

TRUE when all arguments are valid

Author(s)

Astrid Deschênes

Examples

## Check that all arguments are valid
enrichViewNet:::validateCreateEnrichMapSubSectionArguments(
    showCategory=20, groupCategory=FALSE, categoryLabel=1.1, categoryNode=1, 
    line=0.5)

adeschen/gprofiler2cytoscape documentation built on Nov. 4, 2024, 3:16 p.m.