| kegg_category_annotation {kegg} |
R Documentation |
Append the KEGG BRITE category annotation to a given dataframe by the KEGG id column.
Description
Usage
kegg_category_annotation(kegg, anno,
kegg.id = "kegg_id",
class.field = "kegg_class",
category.field = "kegg_category");
Arguments
kegg
the KEGG BRITE background model that is used for query the category information of the KEGG id, for example the model that is created by KO.background. [as Background]
anno
the target dataframe that contains the KEGG id column, the annotation columns will be appended to this dataframe directly. [as dataframe]
kegg.id
the column name of the KEGG id in the anno dataframe. Default kegg_id. [as string]
class.field
the column name of the output KEGG class information. Default kegg_class. [as string]
category.field
the column name of the output KEGG category information. Default kegg_category. [as string]
env
the R# runtime environment. [as Environment]
Details
Only the first KEGG id will be used when the value of the kegg_id column contains multiple ids that are separated by ;, / or other blank characters.
Authors
gseakit
Value
the given dataframe with two new columns (kegg_class and kegg_category) appended, or an error message when the required KEGG id column is missing.
clr value class
Examples
[Package
kegg version 1.0.0.0
Index]