dbparser (version 1.1.1)

carriers_articles: Extracts the drug carriers articles element and return data as tibble.

Description

carriers_articles returns tibble of drug carriers articles elements.

Usage

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

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.

Value

drug carriers_articles node attributes date frame

Details

This functions extracts the carriers articles element of drug node in drugbank xml database with the option to save it in a predefined database via passed database connection. It takes two optional arguments to save the returned tibble in the database save_table and database_connection. It must be called after read_drugbank_xml_db function like any other parser function. 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 carriers: carriers_actions(), carriers_links(), carriers_polypeptide_ext_id(), carriers_polypeptides_go(), carriers_polypeptides_pfams(), carriers_polypeptides_syn(), carriers_polypeptide(), carriers_textbooks(), carriers()

Examples

# NOT RUN {
# return only the parsed tibble
carriers_articles()

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

# save in database in SQLite in memory database and return parsed tibble
sqlite_con <- DBI::dbConnect(RSQLite::SQLite())
carriers_articles(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.
carriers_articles(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.
carriers_articles(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.
carriers_articles(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.
carriers_articles(
  save_csv = TRUE, csv_path = TRUE,
  override = TRUE
)
# }