dbparser (version 1.1.1)

transporters_articles: Extracts the drug transporters articles element and return data as tibble.

Description

transporters articles returns tibble of drug transporters articles elements.

Usage

transporters_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 transporters articles node attributes date frame

Details

This functions extracts the transporters 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 transporters: transporters_actions(), transporters_links(), transporters_polypep_ex_ident(), transporters_polypeptide_go(), transporters_polypeptide_pfams(), transporters_polypeptide_syn(), transporters_polypeptide(), transporters_textbooks(), transporters()

Examples

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

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

# 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.
transporters_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.
transporters_articles(save_table = TRUE, save_csv = TRUE)

# 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.
transporters_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.
transporters_articles(
  save_csv = TRUE, csv_path = TRUE,
  override = TRUE
)
# }