Book Image

Mastering RStudio: Develop, Communicate, and Collaborate with R

4 (1)
Book Image

Mastering RStudio: Develop, Communicate, and Collaborate with R

4 (1)

Overview of this book

RStudio helps you to manage small to large projects by giving you a multi-functional integrated development environment, combined with the power and flexibility of the R programming language, which is becoming the bridge language of data science for developers and analyst worldwide. Mastering the use of RStudio will help you to solve real-world data problems. This book begins by guiding you through the installation of RStudio and explaining the user interface step by step. From there, the next logical step is to use this knowledge to improve your data analysis workflow. We will do this by building up our toolbox to create interactive reports and graphs or even web applications with Shiny. To collaborate with others, we will explore how to use Git and GitHub and how to build your own packages to ensure top quality results. Finally, we put it all together in an interactive dashboard written with R.
Table of Contents (17 chapters)
Mastering RStudio – Develop, Communicate, and Collaborate with R
Credits
About the Authors
About the Reviewer
www.PacktPub.com
Preface
Index

Using roxygen2 for package documentation


As seen before, the documentation of our package is very important but can also get very complex when our package reaches a certain size and number of different functions.

But an alternative to creating and editing all the documentation files on our own is using the roxygen2 package. It was developed by Hadley Wickham, Peter Danenberg, and Manuel Eugster.

The basic idea of roxygen2 is it to make it possible to describe functions directly in comments next to their definition in the code file. The roxygen2 package will then go through the code files and create the corresponding Rd files in the man folder.

Installing the roxygen2 package

The roxygen2 package is available on CRAN and can be installed in the R console with the following command:

install.packages("roxygen2")

If we want to have the latest development version from GitHub, we can install it with the devtools package:

devtools::install_github("klutometis/roxygen")

Generating Rd Files

The basic process...