Convert google comments in text file to rmarkdown footnotes - r

Question

I am working with text files that have been extracted from google docs. The google docs versions have comments and these are included in the file when they are converted to .txt. I would like to programmatically convert each comment to an rmarkdown flavoured footnote.
At present they look like so:
*Background:*[a] Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Nulla[b] a accumsan enim. Aenean sed elit a nunc efficitur pharetra.
*Method:* [c]Praesent dapibus turpis in dictum aliquam.
[a]This should be bolded
[b]What happens to a multiple
line
comment?
[c]How about we make this italics?
The desired output is
*Background:*^[This should be bolded] Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Nulla^[What happens to a multiple
line
comment?] a accumsan enim. Aenean sed elit a nunc efficitur pharetra.
*Method:* ^[How about we make this italics?]Praesent dapibus turpis in dictum aliquam.
There are an unknown number of comments in each file (some files have no comments). As demonstrated - comments can span multiple lines, but the comment text is always at the very end of the file. It's worth noting that there may be square brackets in text other than the comments, so ideally only values that had a comment marker (i.e. [a]) and a corresponding comment at the end of the file (i.e. [a]This should be bolded) would be processed.

Answer 1

Thanks to a (unfortunately now deleted) starting point from #OganM I've now managed to find a working solution.
library(dplyr)
library(stringr)
comment_to_footnote <- function(text) {
pairs <- stringr::str_extract_all(text, '\\[[a-z]\\]') %>% {.[[1]]}
comments <-
stringr::str_extract_all(text, "(?s)\\n\\[[a-z]\\].*?($)") %>% {.[[1]]} %>%
str_split("\\[") %>% {.[[1]]}
comments <-
as.data.frame(cbind(
tag = sapply(str_split(comments, "\\]"), function(x) x[1]),
comment = sapply(str_split(comments, "\\]"), function(x) x[2])
)) %>%
mutate(
pattern = paste0("\\[", tag, "\\]"),
tag = paste0("[", tag, "]"),
comment_clean = str_replace_all(comment, pattern = "\\n", " ")
) %>%
right_join(as.data.frame(x = pairs[duplicated(pairs)]), by = c("tag" = "pairs[duplicated(pairs)]"))
for (i in 1:nrow(comments)) {
# replace the initial occurence of the label with the
# markdown style footer
text = str_replace(
string = text,
pattern = as.character(comments[i, 3]),
replacement = paste0('^[', comments[i, 4], '] ')
)
# get rid of the second occurence of the label that used
# to have the text in it
text = str_remove(string = text,
pattern = paste0("(?s)\\n", comments[i, 3], comments[i, 2], ".*?($)"))
}
return(text)
}
This ignores text in square brackets that does not have a matching comment at the end of the file.
text <- "*Background:*[a][b] Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis maximus urna ac erat tincidunt fermentum. Nulla[c] a accumsan enim. Aenean [d]sed elit a nunc efficitur pharetra. Vivamus ultricies pretium lobortis. Nam bibendum mi vel eros congue, ac ultrices lorem dictum. Orci varius [p < .001] natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed vitae feugiat orci. Integer hendrerit enim nec odio condimentum ornare. Vestibulum nisl quam, porttitor in semper et, porta ac enim. Phasellus a nisl vulputate, [This is handwritten and has no matching comment tag - should not be extracted]luctus mi sit amet, tincidunt enim. Sed ac est pellentesque, aliquam lacus non, rutrum neque. Sed vestibulum magna sit amet ipsum vehicula mollis. Suspendisse orci magna, vulputate ut neque et, consequat aliquam dui.
*Method:* [e]Praesent dapibus turpis in dictum aliquam. Maecenas ac molestie nunc. Nulla varius ultrices purus at blandit. Nulla dolor nisi, lacinia a ante eu, dictum semper nulla. Donec volutpat ultrices tempus. Proin non tristique metus, et tristique ante. Duis malesuada orci sit amet laoreet commodo. Donec faucibus vel erat tempus hendrerit. Vestibulum sit amet massa sit amet velit tempus dignissim. Etiam sed elit lacinia, euismod dui vitae, sagittis enim. Vestibulum ut eleifend orci, a semper massa. Quisque eu fringilla massa, at viverra nulla.[f]
*Results:* In laoreet, eros sed sagittis placerat, erat ex lobortis sem, ut pellentesque velit nisl ac est. Nulla mauris sapien, posuere hendrerit pulvinar a, molestie a orci. Suspendisse vitae risus augue. Nulla vel odio eget tellus sagittis pretium vitae nec enim. Fusce imperdiet, elit [g]maximus pellentesque tincidunt, mauris lacus ultrices massa, eget malesuada elit est et libero. Mauris vehicula urna augue, commodo varius sapien eleifend nec. Aenean ac lacinia nibh, faucibus scelerisque ligula. Sed tortor nisi, dictum ac augue et, auctor posuere ipsum. Curabitur condimentum urna [h]ut mi interdum porttitor. Fusce mi felis, hendrerit quis diam id, facilisis placerat nibh. Aliquam tempor lacus eget orci faucibus, id suscipit libero scelerisque. Nunc ultricies diam vitae vulputate mollis. Pellentesque ullamcorper placerat dui. Praesent lobortis vehicula augue ultricies interdum.
*Conclusion:* Curabitur eleifend ligula felis, ut condimentum lacus egestas nec. Suspendisse faucibus tempus maximus. Sed finibus facilisis ornare. Proin molestie interdum sapien at laoreet. Aenean sagittis dolor non volutpat fringilla. Etiam vulputate justo at orci pharetra condimentum. Mauris condimentum neque libero, in auctor lectus volutpat at. Pellentesque eros lacus, scelerisque eget dictum sed, porttitor sed elit. Morbi tristique nunc vel nunc consectetur, ut tincidunt tellus fermentum. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Vivamus venenatis quis leo quis bibendum. Suspendisse efficitur quam sit amet nisi dignissim sodales. Nullam ex nulla, sagittis a diam non, dapibus scelerisque libero. Fusce ac ante ac dolor congue eleifend eu quis sem. Donec molestie finibus tortor at ullamcorper.[z]
[a]This should be bolded
[b]Comment reply. Good idea!
[c]What happens to a multiple
line
comment?
[d]I don't think this spelling is correct
[e]How about we make this italics?
[f]Gratuitous comments
[g]More here
[h]Add some comments"
cleaned_text <- comment_to_comment(text)
print(cleaned_text)
[1] "*Background:*^[This should be bolded ] ^[Comment reply. Good idea! ] Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis maximus urna ac erat tincidunt fermentum. Nulla^[What happens to a multiple line comment? ] a accumsan enim. Aenean ^[I don't think this spelling is correct ] sed elit a nunc efficitur pharetra. Vivamus ultricies pretium lobortis. Nam bibendum mi vel eros congue, ac ultrices lorem dictum. Orci varius [p < .001] natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed vitae feugiat orci. Integer hendrerit enim nec odio condimentum ornare. Vestibulum nisl quam, porttitor in semper et, porta ac enim. Phasellus a nisl vulputate, [This is handwritten and has no matching comment tag - should not be extracted]luctus mi sit amet, tincidunt enim. Sed ac est pellentesque, aliquam lacus non, rutrum neque. Sed vestibulum magna sit amet ipsum vehicula mollis. Suspendisse orci magna, vulputate ut neque et, consequat aliquam dui.\n\n\n*Method:* ^[How about we make this italics? ] Praesent dapibus turpis in dictum aliquam. Maecenas ac molestie nunc. Nulla varius ultrices purus at blandit. Nulla dolor nisi, lacinia a ante eu, dictum semper nulla. Donec volutpat ultrices tempus. Proin non tristique metus, et tristique ante. Duis malesuada orci sit amet laoreet commodo. Donec faucibus vel erat tempus hendrerit. Vestibulum sit amet massa sit amet velit tempus dignissim. Etiam sed elit lacinia, euismod dui vitae, sagittis enim. Vestibulum ut eleifend orci, a semper massa. Quisque eu fringilla massa, at viverra nulla.^[Gratuitous comments ] \n\n\n*Results:* In laoreet, eros sed sagittis placerat, erat ex lobortis sem, ut pellentesque velit nisl ac est. Nulla mauris sapien, posuere hendrerit pulvinar a, molestie a orci. Suspendisse vitae risus augue. Nulla vel odio eget tellus sagittis pretium vitae nec enim. Fusce imperdiet, elit ^[More here ] maximus pellentesque tincidunt, mauris lacus ultrices massa, eget malesuada elit est et libero. Mauris vehicula urna augue, commodo varius sapien eleifend nec. Aenean ac lacinia nibh, faucibus scelerisque ligula. Sed tortor nisi, dictum ac augue et, auctor posuere ipsum. Curabitur condimentum urna ^[Add some comments] ut mi interdum porttitor. Fusce mi felis, hendrerit quis diam id, facilisis placerat nibh. Aliquam tempor lacus eget orci faucibus, id suscipit libero scelerisque. Nunc ultricies diam vitae vulputate mollis. Pellentesque ullamcorper placerat dui. Praesent lobortis vehicula augue ultricies interdum.\n\n\n*Conclusion:* Curabitur eleifend ligula felis, ut condimentum lacus egestas nec. Suspendisse faucibus tempus maximus. Sed finibus facilisis ornare. Proin molestie interdum sapien at laoreet. Aenean sagittis dolor non volutpat fringilla. Etiam vulputate justo at orci pharetra condimentum. Mauris condimentum neque libero, in auctor lectus volutpat at. Pellentesque eros lacus, scelerisque eget dictum sed, porttitor sed elit. Morbi tristique nunc vel nunc consectetur, ut tincidunt tellus fermentum. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Vivamus venenatis quis leo quis bibendum. Suspendisse efficitur quam sit amet nisi dignissim sodales. Nullam ex nulla, sagittis a diam non, dapibus scelerisque libero. Fusce ac ante ac dolor congue eleifend eu quis sem. Donec molestie finibus tortor at ullamcorper.[z]\n\n"
This seems to work, but I'm sure that there are more elegant solutions.