Skip to content

Commit 9e11f95

Browse files
committed
Fixes to pass CHECK and BiocCheck, bumped version for submission.
Also some small rewording to the vignette.
1 parent bb46d73 commit 9e11f95

5 files changed

Lines changed: 42 additions & 6 deletions

File tree

DESCRIPTION

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Package: gesel
2-
Version: 0.1.12
3-
Date: 2026-04-23
2+
Version: 0.99.0
3+
Date: 2026-05-23
44
Title: Search for Interesting Gene Sets
55
License: MIT + file LICENSE
66
Description:
77
Query the gesel indices to identify interesting gene sets.
88
Users can test for enrichment in their own list of genes and/or search by text in the set names or descriptions.
99
The indices can be hosted remotely or on a local filesystem.
1010
Authors@R:
11-
person("Aaron", "Lun", role=c("aut", "cre"), email="infinite.monkeys.with.keyboards@gmail.com")
11+
person("Aaron", "Lun", role=c("aut", "cre"), email="infinite.monkeys.with.keyboards@gmail.com", comment=c(ORCID="0000-0002-3564-4813"))
1212
Imports:
1313
utils,
1414
methods,
@@ -25,6 +25,12 @@ Suggests:
2525
LinkingTo:
2626
assorthead,
2727
Rcpp
28+
biocViews:
29+
GeneSetEnrichment,
30+
DataImport,
31+
Pathways
32+
URL: https://github.com/gesel-inc/gesel-R
33+
BugReports: https://github.com/gesel-inc/gesel-R/issues
2834
VignetteBuilder: knitr
2935
Encoding: UTF-8
30-
RoxygenNote: 7.3.3
36+
Config/roxygen2/version: 8.0.0

R/fetchSetsForSomeGenes.R

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,10 @@ get_sets_for_some_genes_ranges <- function(config, species, fname) {
104104
#' @return Integer specifying the number of genes in Gesel that belong to at least one set.
105105
#'
106106
#' @author Aaron Lun
107+
#' @examples
108+
#' effectiveNumberOfGenes("10090")
109+
#' effectiveNumberOfGenes("9606")
110+
#' effectiveNumberOfGenes("7227")
107111
#'
108112
#' @export
109113
effectiveNumberOfGenes <- function(species, config = NULL) {

inst/NEWS.Rd

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
\name{gesel News}
2+
\title{gesel News}
3+
\encoding{UTF-8}
4+
5+
\section{Version 1.0.0}{\itemize{
6+
\item First release of the \pkg{gesel} package.
7+
}}
8+

man/effectiveNumberOfGenes.Rd

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vignettes/userguide.Rmd

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ Clients like the `r self` package then use HTTP range requests to perform a vari
2727
No custom server logic is required, greatly reducing effort and cost required to keep Gesel up and running.
2828
Most database files do not need to be downloaded to the client, allowing us to easily scale with increasing numbers of gene sets in the database.
2929

30+
More details can be found at https://github.com/gesel-inc.
31+
A web interface is also available at https://gesel-inc.github.io/web-app.
32+
3033
# Quick start
3134

3235
The raison d'etre of the Gesel database is to find overlaps between known gene sets and a user-supplied list of genes.
@@ -256,7 +259,16 @@ custom.config <- newConfig(
256259
Passing `config = custom.config` to any `r self` function will instruct it to use our custom database files:
257260

258261
```{r}
262+
# Trying a low-level function:
259263
head(fetchAllSets("12345", config = custom.config))
264+
265+
# Trying one of the more user-friendly functions:
266+
head(querySets(
267+
"12345",
268+
genes = sprintf("ensembl_%05d", 1:100),
269+
text = "FOO",
270+
config = custom.config
271+
))
260272
```
261273

262274
It is possible to do some fairly sophisticated things with `newConfig()`, depending on the environment.
@@ -265,8 +277,8 @@ but then fall back to a HTTP request if the R session is running on the cloud.
265277

266278
## Contributing custom sets
267279

268-
If public visibility is not a concern, users might consider contributing their own gene sets to the [default Gesel database](https://github.com/gesel-inc/feedstock).
269-
Contributed gene sets will subsequently be searchable with the default `r self` functions, which may be more convenient than creating a custom database.
280+
Alternatively, you might consider contributing your custom gene sets to the default Gesel database at https://github.com/gesel-inc/feedstock.
281+
Contributed gene sets will be searchable with the default `r self` functions, which may be more convenient than creating a custom database.
270282

271283
# Session information {-}
272284

0 commit comments

Comments
 (0)