check_species: Check species

View source: R/check_species.R

check_speciesR Documentation

Check species

Description

If species arguments are NULL, set default species.

Usage

check_species(
  genelistSpecies = NULL,
  sctSpecies = NULL,
  sctSpecies_origin = NULL,
  sctSpecies_origin_default = "mouse",
  verbose = TRUE
)

Arguments

genelistSpecies

Species that hits genes came from (no longer limited to just "mouse" and "human"). See list_species for all available species.

sctSpecies

Species that sct_data is currently formatted as (no longer limited to just "mouse" and "human"). See list_species for all available species.

sctSpecies_origin

Species that the sct_data originally came from, regardless of its current gene format (e.g. it was previously converted from mouse to human gene orthologs). This is used for computing an appropriate backgrund.

sctSpecies_origin_default

Default value for sctSpecies_origin.

verbose

Print messages.

Value

List of corrected species names.


NathanSkene/EWCE documentation built on Nov. 3, 2024, 8:16 a.m.