Diff of /man/customConvertFeats.Rd [000000] .. [28e211]

Switch to side-by-side view

--- a
+++ b/man/customConvertFeats.Rd
@@ -0,0 +1,28 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/customConverters.R
+\name{customConvertFeats}
+\alias{customConvertFeats}
+\title{Automatic Feature Id Conversion.}
+\usage{
+customConvertFeats(x, verbose = TRUE)
+}
+\arguments{
+\item{x}{data.frame or matrix including raw counts (typically, UMIs),
+where rows are features (genes) and rownames are feature identifiers
+(SYMBOLs or ENTREZIDs).}
+
+\item{verbose}{logical, shall messages be printed to inform about
+conversion advances.}
+}
+\value{
+a data.frame where rownames are ENSEMBL IDs. The new feature IDs are
+automatically imputed based on existing feature IDs (SYMBOLs or ENTREZIDs).
+}
+\description{
+Attempt to automatically convert non-ENSEMBL feature identifiers to
+ENSEMBL identifiers. Features are included as rownames of the input
+data.frame (or matrix). It is assumed that feature identifiers
+(i.e., rownames of x) come from human or mouse genomes, and
+are either OFFICIAL SYMBOLS or ENTREZIDS. If less than 20% of match
+is identified, an error will be thrown.
+}