Cargando…

2079: Updates to the documentation system for R

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 cr...

Descripción completa

Detalles Bibliográficos
Autor principal: Middleton Redd, Andrew
Formato: Online Artículo Texto
Lenguaje:English
Publicado: Cambridge University Press 2018
Materias:
Acceso en línea:https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6801838/
http://dx.doi.org/10.1017/cts.2017.20
_version_ 1783460671924469760
author Middleton Redd, Andrew
author_facet Middleton Redd, Andrew
author_sort Middleton Redd, Andrew
collection PubMed
description 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.
format Online
Article
Text
id pubmed-6801838
institution National Center for Biotechnology Information
language English
publishDate 2018
publisher Cambridge University Press
record_format MEDLINE/PubMed
spelling pubmed-68018382019-10-28 2079: Updates to the documentation system for R Middleton Redd, Andrew J Clin Transl Sci Basic Science/Methodology 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. Cambridge University Press 2018-05-10 /pmc/articles/PMC6801838/ http://dx.doi.org/10.1017/cts.2017.20 Text en © The Association for Clinical and Translational Science 2018 http://creativecommons.org/licenses/by/4.0/ 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.
spellingShingle Basic Science/Methodology
Middleton Redd, Andrew
2079: Updates to the documentation system for R
title 2079: Updates to the documentation system for R
title_full 2079: Updates to the documentation system for R
title_fullStr 2079: Updates to the documentation system for R
title_full_unstemmed 2079: Updates to the documentation system for R
title_short 2079: Updates to the documentation system for R
title_sort 2079: updates to the documentation system for r
topic Basic Science/Methodology
url https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6801838/
http://dx.doi.org/10.1017/cts.2017.20
work_keys_str_mv AT middletonreddandrew 2079updatestothedocumentationsystemforr