KEGG_get: KEGG download API

Description Usage Arguments Details Value Author(s)

View source: R/KEGG.R

Description

API for downloding KEGG info with KEGG offical rest API.

Usage

1
2
3
4
5
6
KEGG_get(
  qid,
  d.path = "KEGG",
  f.type = c("kgml", "image", "htext"),
  force.download = FALSE
)

Arguments

qid

KEGG query id such as KEGG ortholog id like "ko00010", gene name like "ath:AT1G00010" or organism name like "ath" (for KEGG brite file only).

d.path

Destination path (folder) to save or load downloaded file.

f.type

Character string, file type of KEGG entry: "kgml", "aaseq", "ntseq" or "image".

force.download

TRUE/FALSE (default). Force update if TRUE and file exists.

Details

Download XML, image (png), AA sequence or NT sequence file from KEGG website. An alternative function is keggGet implemented in "KEGGREST" package.

Value

path to the saved file.

Author(s)

ZG Zhao


zgzhao/gmetab documentation built on Dec. 23, 2021, 9:17 p.m.