Advertisement

New Ways to Think about Documents

  • Deborah Nolan
  • Duncan Temple Lang
Chapter
Part of the Use R! book series (USE R)

Abstract

This chapter explores some ideas about how we can think of documents in several different ways from the traditional write–format–publish cycle. Instead, we think about documents in some of the same ways we do about software. We want to be able to programmatically verify that a document is “correct,” i.e., unit testing for documents. We want modular components that we can reuse across documents and contexts. We want to be able to express relationships between elements of the document to map to our actual workflow, e.g., tasks and alternative approaches and not just sections, subsections and code chunks. We go beyond dynamic documents and report generation to try to capture the actual research process, concepts, and workflow, and not just their output. This involves semantic markup in the document. While we talk about XML, many of the ideas apply to any mark-up format which we can query and modify programmatically with convenient tools. However, some aspects exploit the richer hierarchical structure of XML, as opposed to the linear format of most document mark-up systems. The goal of this chapter is not to try to convert people to using the system we use to author documents, although it is available and quite powerful. Instead, we want to encourage people to demand more of the tools they use to author documents and to think about authoring documents in new, richer ways.

Keywords

Regular Expression XPath Query XPath Expression Reproducible Research Actual Research Process 
These keywords were added by machine and not by the authors. This process is experimental and the keywords may be updated as the learning algorithm improves.

Preview

Unable to display preview. Download preview PDF.

Unable to display preview. Download preview PDF.

References

  1. [1]
    Neil Bradley. The XSL Companion. Addison-Wesley, London, 2000.Google Scholar
  2. [2]
    Friedrich Leisch. Dynamic generation of statistical reports using literate data analysis. In W. Härdle and B. Roenz, editors, Compstat 2002, Proceedings in Computational Statistics, pages 575–580. Physika Verlag, Heidelberg, 2002.Google Scholar
  3. [3]
    Sal Mangano. XSLT Cookbook: Solutions and Examples for XML and XSLT Developers. O’Reilly Media, Inc., Sebastopol, CA, 2006.Google Scholar
  4. [4]
    Deborah Nolan, Roger Peng, and Duncan Temple Lang. Enhanced dynamic documents for reproducible research. In M.F. Ochs, J.T. Casagrande, and R.V. Davuluri, editors, Biomedical Informatics for Cancer Research, pages 335–346. Springer-Verlag, New York, 2009.Google Scholar
  5. [5]
    Deborah Nolan and Duncan Temple Lang. Dynamic, interactive documents for teaching statistical practice. International Statistical Review, 75:295–321, 2007.Google Scholar
  6. [6]
    Deborah Nolan and Duncan Temple Lang. Learning from the statistician’s lab notebook. In Data and Context in Statistics Education: Towards an Evidence-based Society. Proceedings of the Eighth International Conference on Teaching Statistics (ICOTS8, July, 2010), Ljubljana, Slovenia. Voorburg, 2010.Google Scholar
  7. [7]
    Deborah Nolan and Duncan Temple Lang. XDynDocs: Dynamic documents with XML and XSL. http://www.omegahat.org/XDynDocs, 2011. R package version 0.3-1.
  8. [8]
    Dave Pawson. XSL-FO: Making XML Look Good in Print. O’Reilly Media, Inc., Sebastopol, CA, 2002.Google Scholar
  9. [9]
    Karthik Ram and Duncan Temple Lang. rProv: Provenance tracking in R. https://github.com/karthikram/RProvenance, 2012. R package version 0.2-0.
  10. [10]
    Bob Stayton. DocBook XSL: The Complete Guide. Sagehill Enterprises, Santa Cruz, CA, fourth edition, 2007.Google Scholar
  11. [11]
    Duncan Temple Lang. RCSS: Facilities for reading and working with CSS files in R. http://www.omegahat.org/RCSS, 2011. R package version 0.2-0.
  12. [12]
    Duncan Temple Lang. Sxslt: R extension for liblibxslt. http://www.omegahat.org/Sxslt, 2011. R package version 0.91-1.
  13. [13]
    Duncan Temple Lang. XDocTools: Tools for working with XML and XSL documents. http://www.omegahat.org/XDocTools, 2011. R package version 0.1-0.
  14. [14]
    Duncan Temple Lang, Roger Peng, and Deborah Nolan. CodeDepends: Analysis of R code for reproducible research and code comprehension. http://www.omegahat.org/CodeDepends, 2011. R package version 0.2-1.
  15. [15]
    Jeni Tennison. Beginning XSLT 2.0: From Novice to Professional. Apress, Berkeley, CA, 2005.Google Scholar
  16. [16]
    Hadley Wickham, Peter Danenberg, and Manuel Eugster. roxygen2: A Doxygen-like insourcedocumentation system for Rd, collation, and NAMESPACE. http://cran.rproject.org/web/packages/roxygen2/, 2011. R package version 2.2.2.
  17. [17]
    Yihui Xie. knitr: A general-purpose package for dynamic report generation in R. http://cran.r-project.org/web/packages/knitr/index.html, 2013. R package version 1.0.

Copyright information

© Springer Science+Business Media New York 2014

Authors and Affiliations

  • Deborah Nolan
    • 1
  • Duncan Temple Lang
    • 2
  1. 1.Department of StatisticsUniversity of CaliforniaBerkeleyUSA
  2. 2.Department of StatisticsUniversity of CaliforniaDavisUSA

Personalised recommendations