geneSetCollectionURLfunction {sparrow} | R Documentation

## Get/set the gene set collection url function for a geneset collection

### Description

Reference `collectionMetadata()` for more info.

### Usage

    geneSetCollectionURLfunction(x, i, ...)

    geneSetCollectionURLfunction(x, i) <- value

    ## S4 method for signature 'GeneSetDb'
    geneSetCollectionURLfunction(x, i, ...)

    ## S4 replacement method for signature 'GeneSetDb'
    geneSetCollectionURLfunction(x, i) <- value

    ## S4 method for signature 'SparrowResult'
    geneSetCollectionURLfunction(x, i, ...)

### Arguments

`x` | The GeneSetDb
`i` | The collection to get the url function from
`...` | pass through arguments (not used)
`value` | the function to set as the geneset url function for the given collection `i`. This can be an actual function object, or the (string) name of the function to pull out of "the ether" (`"pkgname::functionname"` can work, too). The latter is preferred as it results in smaller serialized GeneSetDb objects.

### Value

the function that maps collection,name combinations to an informational URL.

### Methods (by class)

- `GeneSetDb`: returns the gene set collection url function from a GeneSetDb

- `GeneSetDb`: sets the gene set collection url function for a `GeneSetDb : Collection` combination.

- `SparrowResult`: return the url function from a `SparrowResult` object.

### Examples

    gdb <- exampleGeneSetDb()
    geneSetCollectionURLfunction(gdb, "c2", "BIOCARTA_AGPCR_PATHWAY")

[Package sparrow version 1.0.3 Index]