Skip to contents

Update Protocol Status

update_protocol_status.Rd

update_protocol_status() changes active flag on existing protocol in the protocol lookup table

Usage

update_protocol_status(con, protocol_id, set_active = TRUE)

Arguments

con

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

protocol_id

A numeric ID for the targeted protocol get_agencies

set_active

A boolean, TRUE for activating and FALSE for deactivating. When a record is active, it is returned by default when get_agencies is called. This helps preserve look up values that are valid in historic contexts, but are no longer valid for current data records.

See also

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

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_agencies <- get_agencies(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_agencies) # to view the ID of the protocol needing status change
#> Error in eval(expr, envir, enclos): object 'all_agencies' not found

#deactivate
update_protocol_status(con, 4, set_active=FALSE)
#> Error in h(simpleError(msg, call)): error in evaluating the argument 'dbObj' in selecting a method for function 'dbIsValid': object 'con' not found
#reactivate
update_protocol_status(con, 4)
#> Error in h(simpleError(msg, call)): error in evaluating the argument 'dbObj' in selecting a method for function 'dbIsValid': object 'con' not found