getUserAnnotations: List installed custom user-defined sitadela annotations

View source: R/sitadela.R

getUserAnnotationsR Documentation

List installed custom user-defined sitadela annotations

Description

This function returns a data frame with information on locally installed, custom user-defined annotations only. For a list of all annotations, see getInstalledAnnotations.

Usage

    getUserAnnotations(obj = NULL)

Arguments

obj

NULL or the path to a sitadela SQLite annotation database. If NULL, the function will try to guess the location of the SQLite database.

Value

The function returns a data.frame object with the installed, custom, user-defined local annotations only.

Author(s)

Panagiotis Moulos

Examples

db <- file.path(system.file(package="sitadela"),
    "annotation.sqlite")
if (file.exists(db))
    u <- getUserAnnotations(obj=db)

pmoulos/sitadela documentation built on May 19, 2024, 3:52 a.m.