Delete Sample Type
delete_sample_type.Rd
delete_sample_type()
deletes an existing sample type in the sample type lookup table
Arguments
- con
A DBI connection object obtained from DBI::dbConnect()
- sample_type_id
A numeric ID for the targeted sample type
get_sample_types
Note: If an sample type has been associated with a sample, then the database restricts deleting this sample type. You must first update those records with a new sample type before reattempting to delete the sample type. Consider using theupdate_sample_type_status
function if you are wanting to retire an sample type while retaining its value for historic records.
See also
Other sample type functions:
add_sample_type()
,
get_sample_types()
,
update_sample_type()
,
update_sample_type_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_sample_types <- get_sample_types(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_sample_types) # to view the ID of the sample type needing deletion
#> Error in eval(expr, envir, enclos): object 'all_sample_types' not found
delete_sample_type(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