dbPars: Set Database Parameters

Description Usage Arguments Details Value References See Also

Description

Sets the connection parameters for a PostgreSQL database and, as a side effect, creates the database, if it does not yet exist.

Usage

1
dbPars(host = "localhost", port = 5432, dbname, user = "postgres", password)

Arguments

host

A vector of mode "character", giving the name of the host, most often this will be "localhost".

port

Numeric, giving the port number, most often 5432.

dbname

A vector of mode "character", giving the name of the database.

user

A vector of mode "character", giving the name of the user.

password

A vector of mode "character", giving the password.

Details

megaptera stores all data internally in a PostgreSQL database. Therefore, dbPars represents the first step in setting up a megaptera project pipeline. See dbConnect and PostgreSQL for further details about the connection parameters and procedure.

Value

An object of class dbPars.

References

See the documentation at the PostgreSQL Web site http://www.postgresql.org for details.

See Also

dbPars for the class' description; taxon, locus, and megapteraPars for defining of taxa, loci, and the pipeline's parameters, respectively; and megapteraProj for the bundling of input data.


heibl/megaptera documentation built on Jan. 17, 2021, 3:34 a.m.