Skip to contents

Delete Protocol

delete_protocol.Rd

delete_protocol() deletes an existing protocol in the protocol lookup table

Usage

delete_protocol(con, protocol_id)

Arguments

con

A DBI connection object obtained from DBI::dbConnect()

protocol_id

A numeric ID for the targeted protocol get_protocols Note: If an protocol has been associated with a assay result record, then the database restricts deleting this protocol. You must first update those records with a new protocol before reattempting to delete the protocol. Consider using the update_protocol_status function if you are wanting to retire an protocol while retaining its value for historic records.

See also

Other protocol functions: add_protocol(), add_protocol_based_on(), get_protocols(), update_protocol(), update_protocol_status()

Examples

# example database connection
cfg <- config::get()
con <- DBI::dbConnect(RPostgres::Postgres(),
                      dbname = cfg$dbname,
                      host = cfg$host,
                      port = cfg$port,
                      user = cfg$username,
                      password = cfg$password)
#> Error: connection to server at "localhost" (::1), port 5432 failed: Connection refused (0x0000274D/10061)
#> 	Is the server running on that host and accepting TCP/IP connections?
#> connection to server at "localhost" (127.0.0.1), port 5432 failed: Connection refused (0x0000274D/10061)
#> 	Is the server running on that host and accepting TCP/IP connections?

all_protocols <- get_protocols(con)
#> Error in h(simpleError(msg, call)): error in evaluating the argument 'dbObj' in selecting a method for function 'dbIsValid': object 'con' not found
View(all_protocols) # to view the ID of the protocol needing deletion
#> Error in eval(expr, envir, enclos): object 'all_protocols' not found

delete_protocol(con, 1)
#> Error in h(simpleError(msg, call)): error in evaluating the argument 'dbObj' in selecting a method for function 'dbIsValid': object 'con' not found