makeDB: Creates (an empty) MMDIT database

Description Usage Arguments Value Examples

View source: R/initMMDIT.R

Description

This *creates* an EMPTY MMDIT database

Usage

1
makeDB(path, dbFilename, overwrite = FALSE)

Arguments

path

a directory (e.g., data)

dbFilename

(e.g., mmdit.sqlite3)

overwrite

(if there's already a file with that name, should I overwrite it?) and creates a database with the requisite tables in it if overwrite is FALSE, then it won't overwrite an existing database in that path. otherwise, it will clobber what was there (use overwrite=TRUE with caution!!)

Value

the handle to the database (throughout all other documentation, this is db)

Examples

1
2
3
4
5
6
7
8
## Not run: 
# Make a new MMDIT database...

db <- makeDB(dataDir, dbName, overwrite=TRUE )
# add the reference genome (can be only 1)
loadReferenceGenome(db, paste(dataDir, refGenome, sep="/") )

## End(Not run)

Ahhgust/MMDIT documentation built on Jan. 27, 2021, 11:48 a.m.