createKEGGdb

https://github.com/yulab-smu/createkeggdb
Admin
createKEGGdb queries online KEGG annotations to generate local KEGG.db packages for use with...
Tokens:703
Snippets:14
Trust Score:8.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install createKEGGdb via remotes

Source: https://github.com/yulab-smu/createkeggdb/blob/master/README.md

Use the remotes package to install the createKEGGdb package directly from the YuLab-SMU GitHub repository.

```r
## install.packages("remotes")
remotes::install_github("YuLab-SMU/createKEGGdb")
```

--------------------------------

### create_kegg_db_microbiota(output_dir = ".", include = c("bacteria", "archaea", "fungi", "viruses"), author = NULL, maintainer = NULL)

Source: https://github.com/yulab-smu/createkeggdb/blob/master/man/create_kegg_db_microbiota.Rd

Creates a KEGG.db package for selected microbiota groups by querying the KEGG organism list.

```APIDOC
## create_kegg_db_microbiota

### Description
Queries the KEGG organism list and builds a KEGG.db package for selected microbiota groups.

### Arguments
- **output_dir** (string) - Optional - Output directory to write the generated KEGG.db package. Defaults to ".".
- **include** (vector) - Optional - Microbiota groups to include. Defaults to c("bacteria", "archaea", "fungi", "viruses").
- **author** (string) - Optional - A string for the Author field in the generated package DESCRIPTION.
- **maintainer** (string) - Optional - A string for the Maintainer field in the generated package DESCRIPTION.

### Returns
- **paths** (character) - Paths of the generated package tarballs.
```

--------------------------------

### create_kegg_db(species, author = NULL, maintainer = NULL)

Source: https://github.com/yulab-smu/createkeggdb/blob/master/man/create_kegg_db.Rd

Generates a KEGG.db package in the current working directory for a given species.

```APIDOC
## create_kegg_db(species, author = NULL, maintainer = NULL)

### Description
Generates a KEGG.db package for a specified species. The resulting package is created in the current working directory.

### Parameters
- **species** (string) - Required - One of KEGG supported species (e.g., 'hsa' for human).
- **author** (string) - Optional - The value for the Author field in the generated package DESCRIPTION file.
- **maintainer** (string) - Optional - The value for the Maintainer field in the generated package DESCRIPTION file.

### Returns
- **KEGG.db package** - The generated package is saved in the working directory.
```
Tokens:
Raw