Learn R Programming

⚠️There's a newer version (0.1.4) of this package.Take me there.

pubtatordb

The goal of pubtatordb is to allow users to create and query a local version of the PubTator database. PubTator provides detailed annotations of abstracts found on PubMed. It is therefore very useful for directing research questions. While PubTator does provide an API, the use of a local database is more appropriate for high-throughput analyses. pubtatordb provides the tools necessary to download, setup, and query such a database.

Installation

You can install the released version of pubtatordb from CRAN with:

install.packages("pubtatordb")

The version on GitHub can be downloaded using the devtools package with:

install.packages("devtools")
devtools::install_github("MAMC-DCI/pubtatordb")

Example

Querying is only four steps away:

# Load the package.
library(pubtatordb)

# Download the data.
download_pt(getwd())

# Create the database.
pubtator_path <- file.path(getwd(), "PubTator")
pt_to_sql(
  pubtator_path,
  skip_behavior = FALSE,
  remove_behavior = TRUE,
  db_from_scratch = TRUE
)

# Create a connection to the database.
db_con <- pt_connector(pubtator_path)

# Query the data.
pt_select(
  db_con,
  "gene",
  columns = NULL,
  keys = NULL,
  keytype = NULL,
  limit = 5
)

Disclaimer

The views expressed are those of the author(s) and do not reflect the official policy of the Department of the Army, the Department of Defense or the U.S. Government.

Copy Link

Version

Install

install.packages('pubtatordb')

Monthly Downloads

44

Version

0.1.3

License

MIT + file LICENSE

Maintainer

Zachary Colburn

Last Published

March 13th, 2019

Functions in pubtatordb (0.1.3)

make_pubtator_sqlite_path

Make a path to the PubTator sqlite file.
download_pt

Download PubTator data via ftp.
pt_to_sql

Create sqlite database from the pubtator data.
pt_select

Retrieve data from the PubTator database.
pt_tables

List the tables in the PubTator sqlite database
pubtator_ftp_url

NCBI's ftp url definition for PubTator.
pubtator_tables

Table and dataset definitions
pt_columns

List the column names for a table in the PubTator sqlite database
pt_connector

Connect to pubtator.sqlite
pubtator_citations

See the citations for PubTator