dbparser (version 1.2.0)

drug_external_links: Drug External Links parser

Description

Links to other websites or databases providing information about this drug.

Usage

drug_external_links(
  save_table = FALSE,
  save_csv = FALSE,
  csv_path = ".",
  override_csv = FALSE,
  database_connection = NULL
)

Value

a tibble with the following variables:

resource

Name of the source website.

identifier

Identifier for this drug in the given resource

drugbank_id

drugbank id

Arguments

save_table

boolean, save table in database if true.

save_csv

boolean, save csv version of parsed tibble if true

csv_path

location to save csv files into it, default is current location, save_csv must be true

override_csv

override existing csv, if any, in case it is true in the new parse operation

database_connection

DBI connection object that holds a connection to user defined database. If save_table is enabled without providing value for this function an error will be thrown.

read_drugbank_xml_db

read_drugbank_xml_db function must be called first before any parser.

If read_drugbank_xml_db is called before for any reason, so no need to call it again before calling this function.

See Also

Other drugs: drug_affected_organisms(), drug_ahfs_codes(), drug_atc_codes(), drug_calc_prop(), drug_categories(), drug_classification(), drug_dosages(), drug_ex_identity(), drug_exp_prop(), drug_food_interactions(), drug_general_information(), drug_groups(), drug_interactions(), drug_intern_brand(), drug_manufacturers(), drug_mixtures(), drug_packagers(), drug_patents(), drug_pdb_entries(), drug_pharmacology(), drug_prices(), drug_products(), drug_reactions_enzymes(), drug_reactions(), drug_salts(), drug_sequences(), drug_snp_adverse_reactions(), drug_snp_effects(), drug_syn()

Examples

if (FALSE) {
# the same parameters and usage will be applied for any parser
# return only the parsed tibble
run_all_parsers()

# will throw an error, as database_connection is NULL
run_all_parsers(save_table = TRUE)

# save in database in SQLite in memory database and return parsed tibble
sqlite_con <- DBI::dbConnect(RSQLite::SQLite())
run_all_parsers(save_table = TRUE, database_connection = sqlite_con)

# save parsed tibble as csv if it does not exist in current location,
# and return parsed tibble.
# if the csv exist before read it and return its data.
run_all_parsers(save_csv = TRUE)

# save in database, save parsed tibble as csv,
# if it does not exist in current location and return parsed tibble.
# if the csv exist before read it and return its data.
run_all_parsers(save_table = TRUE, save_csv = TRUE,
database_connection = sqlite_con)

# save parsed tibble as csv if it does not exist in given location,
# and return parsed tibble.
# if the csv exist before read it and return its data.
run_all_parsers(save_csv = TRUE, csv_path = TRUE)

# save parsed tibble as csv if it does not exist in current location and
# return parsed tibble.
# if the csv exist override it and return it.
run_all_parsers(save_csv = TRUE, csv_path = TRUE, override = TRUE)
}