Hostname: page-component-848d4c4894-8bljj Total loading time: 0 Render date: 2024-06-26T04:03:31.243Z Has data issue: false hasContentIssue false

2079

Updates to the documentation system for R

Published online by Cambridge University Press:  10 May 2018

Andrew Middleton Redd*
Affiliation:
The University of Utah School of Medicine, Salt Lake City, UT, USA
Rights & Permissions [Opens in a new window]

Abstract

Core share and HTML view are not available for this content. However, as you have access to this content, a full PDF is available via the ‘Save PDF’ action button.

OBJECTIVES/SPECIFIC AIMS: This research seeks to create a next generation documentation system that exists independent of but is complimentary to the packaging system in R. The new documentation can be manipulated programmatically as with all R objects. It also implements multiple translators for creating documentation from different sources, including documentation pages written in latex and code comments. METHODS/STUDY POPULATION: This work is based on input from the R Documentation Task Force, which is a working group, supported by the R Consortium and the University of Utah Center for Clinical and Translational Science, consisting of R Core developers, representatives from the R Consortium member companies and community developers with relevant interest in documentation. An abstraction of the documentation currently in use was created and extended. This abstraction was translated to a class system in R so that documentation can be stored and manipulated in R. RESULTS/ANTICIPATED RESULTS: The class system representing the documentation and the tools for creating the translators are currently being implemented in R. A preview of the system is scheduled to be available at the time of the conference. DISCUSSION/SIGNIFICANCE OF IMPACT: Good documentation is critical for researchers to disseminate computational research methods, either internally or externally to their organization. This work will facilitate the creation of documentation by making documentation immediately accessible and promote documentation consumption through multiple outputs which can be implemented by developers.

Type
Basic Science/Methodology
Creative Commons
Creative Common License - CCCreative Common License - BY
This is an Open Access article, distributed under the terms of the Creative Commons Attribution licence (http://creativecommons.org/licenses/by/4.0/), which permits unrestricted reuse, distribution, and reproduction in any medium, provided the original work is properly cited.
Copyright
© The Association for Clinical and Translational Science 2018