Skip to contents

Displays information about passed dbobject object including basic info, database metadata, and all data.frames contained within nested lists.

Usage

show_dvobject_metadata(obj, return_df = FALSE)

Arguments

obj

A dvobject

return_df

Logical. If TRUE, returns metadata data.frame without printing. Default is FALSE.

Value

Invisibly returns a data.frame containing dvobject metadata

Examples

drugbank <- parseDrugBank(
  system.file("extdata", "drugbank_record_biotech.xml",
              package = "dbparser"))
#> Loading DrugBank DB from path: /github/home/R/x86_64-pc-linux-gnu-library/4.6/dbparser/extdata/drugbank_record_biotech.xml
#> Completed loading DrugBank DB into memory
#> ...........................................
#> parsing drugs elements
#> drugs information parsing has started
#> parsing drugs general information
show_dvobject_metadata(drugbank)
#> === BASIC INFO ===
#>      Class Total_DataFrames Top_Level_Lists Object_Size
#> 1 dvobject                1               1     10.7 Kb
#> 
#> === DATABASE METADATA ===
#>  Database     Type Version Export_Date
#>  Original DrugBank     5.1  2018-07-03
#> 
#> === DATA.FRAMES ===
#>                       Path Rows Cols   Size
#>  drugs$general_information    1   15 4.5 Kb
metadata <- show_dvobject_metadata(drugbank, return_df = TRUE)