print_gene_info: Print gene information

In kueckelj/confuns: Convenience Functions

Print gene information

Description

Prints human readable summary texts of genes in the console.

Usage

print_gene_info(
  genes,
  use_synonyms = TRUE,
  ignore_case = TRUE,
  check = TRUE,
  warn = TRUE,
  ...
)

Arguments

genes	Character vector of gene names.
use_synonyms	Logical value. If TRUE, genes that were not matched via their official gene symbol are looked for via their known synonyms.
ignore_case	Logical value. If TRUE, ignores case when matching gene names. (Gene symbols are stored with capitalized letters. Providing 'Gfap' as input for genes will fail if ignore_case is FALSE as the symbol under which the gene is stored is written as 'GFAP').
check	Logical value. If TRUE, input is checked for availability. If FALSE, unknown elements are silently dropped.
warn	Logical. If TRUE, a warning is printed if elements of argument input are neither identified as a gene symbol nor as matching synonym.
...	Additional arguments given to filter_genes(). Is only applied if ... is not empty.

Details

See documentation for ?gene_info_df to read about how the source data.frame has been generated.

Value

Invisible TRUE. Texts are immediately printed using base::writeLines().

Examples

 # genes are checked for validity by default
 print_gene_info(genes = c("GFAP", "MAG", "OLIG1", "XYZ"))

 # set check = FALSE to drop unknown genes silently
 print_gene_info(genes = c("GFAP", "MAG", "OLIG1", "XYZ"), check = FALSE)

 # use arguments of filter_genes()
 print_gene_info(c("KCNH2", "NRROS"))
 print_gene_info(c("KCNH2", "NRROS"), catchphrase = "development")

kueckelj/confuns documentation built on June 28, 2024, 9:19 a.m.