Search code examples
rr-markdownxml2

Parse html-comments with xml2


I am starting to experiment with the xml2-package to parse some Rmarkdown-Files. Right now, I am very intersted in parsing html-comments in a structured manner and also in parsing the information between sections (e.g. #### etc)

My current attempt to acess the content of the comments can be found below.


library(xml2)
library(magrittr)

# html-output as created by rmarkdown
x <- xml2::read_xml("
  <div id='header-level-1' class='section level1'>
  <h1>Header Level 1</h1>
  <!-- This is a comment, which I want to parse -->
  <div id='header-level-4-1' class='section level4'>
  <h4>Header Level 4 (1)</h4>
  <!-- parse me 4 (1) -->
  <p>Hello!</p>
  </div>
  <div id='header-level-4-2' class='section level4'>
  <h4>Header Level 4 (2)</h4>
  <!-- parse me 4 (2) -->
  <p>How are you?</p>
  <pre class='r'><code>print(&quot;Hello World&quot;)</code></pre>
  </div>
  </div>
")

# inspecting the structure, {comments} are present as a structural element
x %>% 
  html_structure()
#> <div#header-level-1 .section.level1>
#>   <h1>
#>     {text}
#>   {comment}
#>   <div#header-level-4-1 .section.level4>
#>     <h4>
#>       {text}
#>     {comment}
#>     <p>
#>       {text}
#>   <div#header-level-4-2 .section.level4>
#>     <h4>
#>       {text}
#>     {comment}
#>     <p>
#>       {text}
#>     <pre.r>
#>       <code>
#>         {text}

# first attempt to acess content of comments
x %>% 
  xml_find_all("//div") %>%
  sub("^.*<!-- ", "", .) %>% 
  sub(" -->.*$", "", .)
#> [1] "parse me 4 (2)" "parse me 4 (1)" "parse me 4 (2)"

I am sure, there is a better way? Ideally, I would get the comments and keep the hierarchical structure (which headings these comments belonged to e.g.)


Solution

  • xml_find_all(x, ".//*/comment()/../div")
    ## {xml_nodeset (2)}
    ## [1] <div id="header-level-4-1" class="section level4">\n  <h4>Header Level 4 (1)</h4>\n  <!-- parse me 4 (1) -->\n  <p>He ...
    ## [2] <div id="header-level-4-2" class="section level4">\n  <h4>Header Level 4 (2)</h4>\n  <!-- parse me 4 (2) -->\n  <p>Ho ...