Skip to content

Commit c219eb6

Browse files
Changed DESCRIPTION and README files
1 parent bd69aee commit c219eb6

File tree

3 files changed

+79
-14
lines changed

3 files changed

+79
-14
lines changed

DESCRIPTION

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
Package: KEGGPackage
2-
Title: KEGG database Tools
3-
Version: 0.0.1.000
1+
Package: KEGGSearch
2+
Title: KEGGSearch: Comprehensive KEGG Data Retrieval Using Multiple Sources
3+
Version: 0.1.1.000
44
Authors@R:
55
person("Gabriele", "Conti", , "conti.gabriele@outlook.com", role = c("aut", "cre"),
66
comment = c(ORCID = "0000-0002-4623-043X"))
7-
Description: Useful function to query the KEGG databses using KEGG API
7+
Description: The KEGGSearch package provides an extensive toolkit for retrieving KEGG (Kyoto Encyclopedia of Genes and Genomes) information from multiple sources, enabling flexible and comprehensive access to biological pathway and module data. It includes functions to query KEGG IDs via the official KEGG REST API and alternative sources such as Bio2RDF, as well as a manually curated dataset for enhanced coverage of KEGG modules. The package facilitates efficient data extraction and integration for bioinformatics analysis.
88
License: MIT + file LICENSE
99
Encoding: UTF-8
1010
Roxygen: list(markdown = TRUE)

README.Rmd

+32-3
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,32 @@ knitr::opts_chunk$set(
1313
)
1414
```
1515

16-
# KEGGPackage
16+
# KEGGSearch: Comprehensive KEGG Data Retrieval Using Multiple Sources
1717

1818
<!-- badges: start -->
1919
<!-- badges: end -->
2020

21-
The goal of KEGGPackage is to provide useful function to quering the KEGG databases using KEGG API
21+
## Description
22+
23+
The KEGGSearch package provides an extensive toolkit for retrieving KEGG (Kyoto Encyclopedia of Genes and Genomes) information from multiple sources, enabling flexible and comprehensive access to biological pathway and module data. It includes functions to query KEGG IDs via the official KEGG REST API and alternative sources such as Bio2RDF, as well as a manually curated dataset for enhanced coverage of KEGG modules. The package facilitates efficient data extraction and integration for bioinformatics analysis.
24+
25+
## Key Functions
26+
27+
* *KEGGList()* – Retrieves KEGG entity names (pathways, compounds, etc.) using the official KEGG REST API.
28+
* *GETKEGGNames()* – Fetches KEGG entity names via the Bio2RDF API as an alternative data source.
29+
* *GETKEGG_Module()* – Combines Bio2RDF data with a manually curated KEGG module table to enhance data availability.
30+
31+
This package is useful for researchers and bioinformaticians needing reliable and extensive access to KEGG resources for biological analysis and pathway enrichment studies.
2232

2333
## Installation
2434

25-
You can install the development version of KEGGPackage from [GitHub](https://github.com/) with:
35+
You can install the development version of KEGGSearch from [GitHub](https://github.com/) with:
2636

2737
``` r
2838
# install.packages("devtools")
2939
devtools::install_github("Gabriele-Conti/KEGGSearch")
3040
```
41+
Depends: dplyr, tibble, httr, jsonlite
3142

3243
## Example
3344

@@ -57,3 +68,21 @@ result <- GETKEGG_Module(modules_IDs)
5768
print(result)
5869
5970
```
71+
72+
## Citation
73+
74+
If you use this R package please cite this GitHub in your article:
75+
76+
```
77+
@Manual{,
78+
title = {KEGGSearch: Comprehensive KEGG Data Retrieval Using Multiple Sources},
79+
author = {Gabriele Conti},
80+
year = {2025},
81+
note = {R package version 0.0.1},
82+
url = {https://github.com/Gabriele-Conti/KEGGSearch.git},
83+
}
84+
```
85+
86+
**Example**
87+
<br>
88+
Conti, G. (2025) KEGGSearch: Comprehensive KEGG Data Retrieval Using Multiple Sources (v0.0.1). Available on Github: https://github.com/Gabriele-Conti/KEGGSearch<br/>

README.md

+43-7
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,47 @@
11

22
<!-- README.md is generated from README.Rmd. Please edit that file -->
33

4-
# KEGGPackage
4+
# KEGGSearch: Comprehensive KEGG Data Retrieval Using Multiple Sources
55

66
<!-- badges: start -->
77
<!-- badges: end -->
88

9-
The goal of KEGGPackage is to provide useful function to quering the
10-
KEGG databases using KEGG API
9+
## Description
10+
11+
The KEGGSearch package provides an extensive toolkit for retrieving KEGG
12+
(Kyoto Encyclopedia of Genes and Genomes) information from multiple
13+
sources, enabling flexible and comprehensive access to biological
14+
pathway and module data. It includes functions to query KEGG IDs via the
15+
official KEGG REST API and alternative sources such as Bio2RDF, as well
16+
as a manually curated dataset for enhanced coverage of KEGG modules. The
17+
package facilitates efficient data extraction and integration for
18+
bioinformatics analysis.
19+
20+
## Key Functions
21+
22+
- *KEGGList()* – Retrieves KEGG entity names (pathways, compounds, etc.)
23+
using the official KEGG REST API.
24+
- *GETKEGGNames()* – Fetches KEGG entity names via the Bio2RDF API as an
25+
alternative data source.
26+
- *GETKEGG_Module()* – Combines Bio2RDF data with a manually curated
27+
KEGG module table to enhance data availability.
28+
29+
This package is useful for researchers and bioinformaticians needing
30+
reliable and extensive access to KEGG resources for biological analysis
31+
and pathway enrichment studies.
1132

1233
## Installation
1334

14-
You can install the development version of KEGGPackage from
35+
You can install the development version of KEGGSearch from
1536
[GitHub](https://github.com/) with:
1637

1738
``` r
1839
# install.packages("devtools")
1940
devtools::install_github("Gabriele-Conti/KEGGSearch")
2041
```
2142

43+
Depends: dplyr, tibble, httr, jsonlite
44+
2245
## Example
2346

2447
This is a basic example which shows you how to solve a common problem:
@@ -36,7 +59,6 @@ entry <- c("map01100", "map01110", "map01120")
3659
result <- KEGGList(entry = entry, database = "pathway")
3760
#> [1] "Selected param: pathway"
3861
#> Querying: https://rest.kegg.jp/list/pathway
39-
4062
print(result)
4163
#> V1 V2
4264
#> 1 map01100 Metabolic pathways
@@ -46,7 +68,6 @@ print(result)
4668
## GETKEGGNames basic example code
4769
KEGG_IDs <- c("map01100", "map01110", "map01120")
4870
result <- GETKEGGNames(KEGG_IDs)
49-
5071
print(result)
5172
#> Names
5273
#> map01100 Metabolic pathways\n [kegg:map01100]
@@ -56,7 +77,6 @@ print(result)
5677
## KEGGList basic example code
5778
modules_IDs <- c("M00005", "M00045", "M00060")
5879
result <- GETKEGG_Module(modules_IDs)
59-
6080
#> All KEGG modules are present in the local database ...
6181
print(result)
6282
#> KEGG.modules
@@ -68,3 +88,19 @@ print(result)
6888
#> M00045 Histidine degradation, histidine => N-formiminoglutamate => glutamate
6989
#> M00060 KDO2-lipid A biosynthesis, Raetz pathway, LpxL-LpxM type
7090
```
91+
92+
## Citation
93+
94+
If you use this R package please cite this GitHub in your article:
95+
96+
@Manual{,
97+
title = {KEGGSearch: Comprehensive KEGG Data Retrieval Using Multiple Sources},
98+
author = {Gabriele Conti},
99+
year = {2025},
100+
note = {R package version 0.0.1},
101+
url = {https://github.com/Gabriele-Conti/KEGGSearch.git},
102+
}
103+
104+
**Example** <br> Conti, G. (2025) KEGGSearch: Comprehensive KEGG Data
105+
Retrieval Using Multiple Sources (v0.0.1). Available on Github:
106+
<https://github.com/Gabriele-Conti/KEGGSearch><br/>

0 commit comments

Comments
 (0)