initializeDb: Create and initialize a database

Description Usage Arguments Value Examples

View source: R/interface.R

Description

Create and initialize a database

Usage

1
2
3
initializeDb(dbPath, datasetName, datasetSpecies = "", datasetSource = "",
  datasetPlatform = "", datasetDescription = "", datasetSaveLocation = "",
  datasetFigureFilename = "")

Arguments

dbPath

Path to the database file to be created. Empty string

datasetName

Name of the data set

datasetSpecies

Optional data set metadata: species

datasetSource

Optional data set metadata: source

datasetPlatform

Optional data set metadata: platform

datasetDescription

Optional data set metadata: description

datasetSaveLocation

Optional data set metadata: save location

datasetFigureFilename

Optional data set metadata: figure file name

Value

A database object db needed by other tigreBrowserWriter functions

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
  # Create a real database to a file
  db <- initializeDb("/path/to/the/database.sqlite", "My Dataset")
  closeDb(db)

## End(Not run)

  # Create a temporary database to be deleted at the end
  db <- initializeDb("", "My Dataset")
  closeDb(db)

tigreBrowserWriter documentation built on May 2, 2019, 12:21 p.m.