This function uses the grepl function on the HemOnc Concept Names and naming patterns to return HemOnc Regimens based on a single Component and total number of Components in the source regimen.
ho_grep_regimens( ..., conn, conn_fun = "connectAthena()", check_validity = TRUE, component_count = NULL, vocab_schema = "omop_vocabulary", cache_only = FALSE, skip_cache = FALSE, override_cache = FALSE, render_sql = TRUE, verbose = TRUE, sleepTime = 1 )
| ... | Characters of length 1 or greater of components that comprise the regimen. |
|---|---|
| conn | Connection object. If provided, diverts queries to the connection instead of the local Athena instance without caching features. |
| check_validity | If TRUE, a query is run to comfirm that there is a HemOnc Component that has an exact string match to each of the components provided. |
| component_count | If NULL or the component_count is larger than the m aximum number of components possible for all Regimens with a positive string match to the `component` parameter, the unfiltered result of the initial query for `components` is returned. |
| cache_only | Loads from the cache and does not query the database. A NULL object is returned if a resultset was not cached. |
| skip_cache | Skip the caching altogether and directly query the database. |
| override_cache | If TRUE, the cache will not be loaded and will be overwritten by a new query. For override_cache to take effect, skip_cache should be FALSE. |
| render_sql | If TRUE, the SQL will be printed back in the console prior to execution. Default: FALSE |
| verbose | If TRUE, prints loading and querying operations messages to the console. Default: FALSE |
| sleepTime | Argument for `Sys.sleep()` in between queries to allow for halting function execution, especially in cases where other chariot functions are executing multiple queries in succession and require cancellation. |