Building your own 'R PACKAGE' and 'DESCRIPTION' file


A package in R is a standardized and structured unit that comprises various components, including 
1. R code
2. Documentation
3. Data
4. External code

Creating a package is initiated by generating a new blank project in R.
Installing 'devtools' and 'roxygen' which help in creating packages and can be done by the following code:
install.packages(“devtools”)
install.packages(“roxygen2”)
library(devtools)
library(roxygen2)
package.skeleton()

It can also be installed directly by implementing code 
devtools::install_github("hadley/devtools")

It creates new files:

  • Data, folder 
  • DESCRIPTION, information file 
  • Man, help folder
  • R folder contains the . R files for functions 
  • And “read-and-delete-me” file

The Description consists of  fundamental information regarding the package in the following sequence: The important and required fields are ‘Package’, ‘Version’, ‘License’, ‘Description’, ‘Title’, ‘Author’, and ‘Maintainer’,  the remaining fields (Date, Suggests, ...) are optional. 

The Package and Version fields give the name and the version of the package, respectively. The name should consist of letters, numbers, and the dot character and start with a letter. 

The version is a sequence of at least two (and usually three) non-negative integers separated by single dots or dashes. 

The Title should be no more than 65 characters, because it will be used in various package listings with one line per package. 

The Author field can contain any number of authors in free text format, 

the Maintainer field should contain only one name plus a valid email address (similar to the “corresponding author” of a paper). The Description field can be of arbitrary length.

Building Package:

It is important to save the code and description accurately.

R file code:




Build tab and check -allows error checking and building.


 

Roxygen-documentation set up

  • In the build tab, configure build tools is selected followed by turning on the generate documentation with roxygen.
  • later in roxygen options, all options are turned on.
  • It is important to start the code file with #’ which documents the code using the oxygen package followed by build, check and reload.




URL to git repo: Description file.R





Comments

Post a Comment

Popular posts from this blog

Mastering Debugging: A Step-by-Step Guide to Fixing Code Errors

Image
  Debugging is a crucial skill for programmers as it assists them in detecting and fixing errors or bugs in their code. In this detailed guide, we will take you through an example of debugging a code snippet and emphasize the essential tactics and tools needed to master the art of debugging. Understanding the Deliberate Bug Let's begin with the code snippet that contains a deliberate bug, which results in an error message during execution. Here's the faulty code, When this code is executed, it triggers an error message due to the unexpected placement of return(outlier.vec) within the for loop. Step 1: Identifying the Error To identify the error, we can use the traceback function, which prints the list of functions called before the error occurred. Running traceback("tukey_multiple") reveals the location of the error just before return(outlier.vec) . Step 2: Using Debugging Tools After locating the error, we implement the debug function to step through the code an...
Read more

My intro to R programming

 Hey everyone! I just tested a function for calculating the mean using R studio, and I'm excited to share the results with you! Please refer to my   GitHub repository  for my work. After applying the function to my dataset (assignment), the mean value is 19.25.  I followed the instructions given by my professor Dr. Friedman and referred the book "The Art of R Programming" by Norman Matloff. Explanation: This function works by summing up all the values in the given dataset (sum(assignment)) and then dividing the sum by the total number of elements in the dataset (length(assignment)) , it calculates the average value of the dataset. The formula for mean is: Mean = Sum of Values / No. of Values In this case, the function successfully computes the mean of the 'assignment' dataset. Feel free to try it out with your own datasets or explore Matloff's book!                                 ...
Read more

A Visual Analysis of Patient Data : Blood Pressure and Medical Assessments

Image
Hello all ✋   In this blog post, we'll be looking into a dataset obtained from a local hospital. This dataset contains blood pressure readings, evaluations by both general and external doctors, and the final decision regarding immediate care for patients. Our aim is to visually analyze the connection between blood pressure and medical assessments. To accomplish this, we'll be using side-by-side boxplots and histograms to identify patterns and trends within the data. To begin our analysis, we need to prepare the data and generate visualizations as in the URL given below. It will create side-by-side boxplots for general and external doctor assessments, along with a histogram showing the overall distribution of blood pressure values. The x-axis represents the assessment (bad or good), while the y-axis represents the blood pressure values.   Patient Health Assessment The boxplot displays: First Assessment (Bad vs. Good): ...
Read more