New R package flatxml: working with XML files as R dataframes

The world is flat

The new R package flatxml provides functions to easily deal with XML files. When parsing an XML document fxml_importXMLFlat produces a special dataframe that is 'flat' by its very nature but contains all necessary information about the hierarchical structure of the underlying XML document (for details on the dataframe see the reference for the fxml_importXMLFlat function). flatxml offers a set of functions to work with this dataframe.

Apart from representing the XML document in a dataframe structure, there is yet another way in which flatxml relates to dataframes: the fxml_toDataFrame function can be used to extract data from an XML document into a dataframe, e.g. to work on the data with statistical functions. Because in this case there is no need to represent the XML document structure as such (it's all about the data contained in the document), there is no representation of the hierarchical structure of the document any more, it's just a normal dataframe.

Each XML element, for example <tag attribute="some value">Here is some text</tag> has certain characteristics that can be accessed via the flatxml interface functions, after an XML document has been imported with \fxml_importXMLFlat. These characteristics are:

  • value: The (text) value of the element, "Here is some text" in the example above
  • attributes: The XML attributes of the element, attribute with its value "some value" in the example above
  • children: The elements on the next lower hierarchical level
  • parent: The element of the next higher hierarchical level, i.e. the element to which the current element is a child
  • siblings: The elements on the same hierarchical level as the current element


Structure of the flatxml interface

The flatxml interface to access these characteristics follows a simple logic: For each of the characteristics there are typically three functions available:

  • fxml_has...(): Determines if the current XML element has (at least one instance of) the characteristic
  • fxml_num...(): Returns the number of the characteristics of the current XML (e.g. the number of children elements
  • fxml_get...(): Returns (the IDs of) the respective characteristics of the current XML element (e.g. the children of the current element)


Learn more

For more information on the flatxml package please go to http://www.zuckarelli.de/flatxml/index.html.

Comments

Post a Comment

Popular posts from this blog

Pointers/shortcuts in R with the ‘pointr’ package

Overview R’s built-in copy-on-modify behavior prevents the user from having two symbols always pointing to the same object. Because pointers, as they are common in other programming languages, are essentially symbols (variables) related to an object that has already another symbol attached to it, it is clear that pointers do not fit naturally into R’s language concept. However, pointers would be indredibly useful, e.g. when you work with complex subsets of dataframes. These complex filtering conditions make the code harder to read and to maintain. For this reason, it would be good to have a kind of ‘abbreviation’ or ‘shortcut’ that lets you write such filtering conditions more efficiently. Thepointr package provides functionality to create pointers to any R object easily, including pointers to subsets/selections from dataframes.  Working with  pointr Installing and loading  pointr To install the CRAN version of  pointr  from the R console, just call: ...
Read more

Converting XML data to R dataframes with xmlconvert

Image
The  xmlconvert  package is made to easily and comfortably convert XML data to R dataframes and the other way around. It provides a lot of options to control the conversion process and to export the results to CSV or Excel files, if desired. How you install  xmlconvert Just execute  install.packages ("x mlconvert", dependencies = TRUE)  in the R console to install the package including all packages it depends on. By default, the  xlsx  package for writing Excel files is not installed together with  xmlconvert .  xmlconvert  will tell you when you need  xlsx  and will ask you to install it then. How you work with  xmlconvert The functions  xml_to_df()  and  df_to_xml()  are the two workhorses of the package. The functions assume that each data record (e.g. a customer) in the XML data is stored in one XML element/tag; the individual fields (e.g. name, address, e-mail), however, can be represente...
Read more

packagefinder now with RStudio add-in

Image
A new version 0.3.0 of the packagefinder package is now available on CRAN. It comes with a new add-in for R Studio that provides a graphical interface to the findPackage() and whatsNew() functions. Finding packages on CRAN is now easier and more comfortable than ever! Here are some impressions.   Install the package from CRAN with install.packages("packagefinder", dependencies = TRUE) The add-in is installed automatically when you install the package. It can be started from the Addins dropdown menu on the RStudio toolbar.  See the packagefinder source code on GitHub . Star and fork the repo! And don't forget to follow me on Twitter to receive more updatates on all my packages and R activities!
Read more