check_bool_args: Check boolean args

View source: R/check_bool_args.R

check_bool_argsR Documentation

Check boolean args

Description

Check that boolean args are indeed boolean

Usage

check_bool_args(
  standardise_genes,
  drop_nonorths,
  as_sparse,
  as_DelayedArray,
  sort_rows
)

Arguments

standardise_genes

If TRUE AND gene_output="columns", a new column "input_gene_standard" will be added to gene_df containing standardised HGNC symbols identified by gorth.

drop_nonorths

Drop genes that don't have an ortholog in the output_species.

as_sparse

Convert gene_df to a sparse matrix. Only works if gene_df is one of the following classes:

  • matrix

  • Matrix

  • data.frame

  • data.table

  • tibble

If gene_df is a sparse matrix to begin with, it will be returned as a sparse matrix (so long as gene_output= "rownames" or "colnames").

as_DelayedArray

Convert aggregated matrix to DelayedArray.

sort_rows

Sort gene_df rows alphanumerically.


neurogenomics/orthogene documentation built on April 17, 2025, 9:30 p.m.