Building 'PACKAGE' and 'DESCRIPTION' file in R

Package in R is a structured, standardized unit consisting of
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’ and other fields are optional.

Package: Veda
Title: Function for Addition
Version: 0.1.0
Date: 2023-03-20
Authors@R: c(person("Veda", "Developer", role = c("aut", "cre"),
                     email = "vedar@some.domain.net"),
                     person("A.", "User", role = "ctb",
                     email = "A.User@whereever.net"))
Author: Veda Developer [aut, cre],
        A. User [ctb]
Maintainer: Veda Developer <vedar@some.domain.net>
Description: This package provides function for adding values in R.It returns the value after calling the function which when implemented can be used to count n number of digits. 
Depends: R (>= 3.1.0)
License: CC0
LazyData: true
RoxygenNote: 7.2.3
Built: R 4.2.2; ; 2023-03-21 03:56:59 UTC; windows

The required 'Package' variable represents the package's identity. It should comprise (ASCII) letters, numerals, and dots, include at least two characters, begin with a letter, and not end with a dot. 
The required 'Title' domain must include a brief summary of the package. A few package items may limit the tagline length to 65 characters. It should use title case (that is, capitalize the main words; tools::toTitleCase can assist you with this). It should not include markup, continuation lines, and period. 
The required 'Version' indicates the package's edition. This is a string that includes a minimum of 2 (typically 3)  integers which are not negative are isolated by single '.' or '-' characters. The foundational form should be in the format of '0.01' or '0.01.0' or are treated as if they were '0.1-0'. This isn't a decimal number, so for example 0.9 < 0.75 since 9 < 75.
The 'Date' field is optional and displays the launch date of the current version of the package. Format of 'yyyy-mm-dd'  is highly advised.
'Authors@R' is the machine-readable description of the author, maintainer, contributors, and others. Fields 'Author' and 'Maintainer' can be auto-generated from 'Authors@R'. These two fields can be omitted if the latter is included. 

Author: Veda Developer [aut, cre],
        A. User [ctb]
Maintainer: Veda Developer vedar@some.domain.net

The required 'Description' domain must contain a detailed description of the tasks the package performs. It should be understandable to the entire intended audience. One paragraph of what the package can perform. It can extend up to 80 characters or less. The following lines should be indented by four spaces.
The 'Depends' field will list the dependencies needed for loading the package. So, these will be installed when the main package is installed. These are loaded as part of its loading. It is visible to the user.
The 'Imports' field will list all the packages that package uses but are not attached to the search path. This means that your package can use the functions from the package, but you will need to call them through 'package:: function()'. These are not loaded and are not visible to the user.
'License' gives the option of the extent of usage of the package i.e whether it is public or limited to some. It should be specified in a standardized form. CC0 1.0 Universal is a dedication to the public waiving all the rights of the work. There are other licenses which dedicate the extent of usage of the package. There is no warranty of correctness or accountability.
The LazyData package provides a different strategy in which datasets are inserted into memory just when required and stored for better accessibility in subsequent sessions. This is notably helpful with big sets of data projects or immersive work where there is the requirement to use subsets of the data at a period.

Building Package:

It is important to save the code and description accurately.

R file code:

#' Add two numbers together
#'
#' This function takes two arguments, `y` and `z`, and returns their sum.
#'
#' @param y a numeric value to be added
#' @param z a numeric value to be added
#'
#' @return the sum of `y` and `z`
#'
#' @examples
#' s(2, 3)
#'
#' @export
s = function(y, z) {
  result = y + z
  return(result)
}

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.

% Please edit documentation in R/sum.R
\name{s}
\alias{s}
\title{Add two numbers together}
\usage{
s(y, z)
}
\arguments{
\item{y}{a numeric value to be added}
\item{z}{a numeric value to be added}
}
\value{
the sum of `y` and `z`
}
\description{
This function takes two arguments, `y` and `z`, and returns their sum.
}
\examples{
s(2, 3)
}

                                            While submitting to CRAN, a file which is in a.tar.gz is created.

                                            • build command will collate the package.
                                            • install command which tests if any errors and this creates Package in R.

                                            In this way, we can build package in R which will make installation and administration easy along with validation checks. It is very useful for programmers as it is self-contained and other packages' requirements can also be applied.

                                            URL to git repo:https://github.com/VedaVangala/vedas-r-repo/tree/main/R10

                                            References

                                            Wickham, H. (2015). R Packages (Chapter 7)

                                            Matloff. N. (2011). The Artof R programming.(Chapter 13)

                                            The R repository https://cran.r-project.org/web/packages




                                            Comments

                                            Post a Comment

                                            Popular posts from this blog

                                            Input/Output, String manipulation and 'plyr' package in R

                                            Image
                                            ✔ This is initiated by creating a dataset in a text file. ‘read.table’ function can be used to read a table from a file in R . ‘file. choose’ opens a dialogue box which allows choosing the text file which was created earlier. ‘header=TRUE’ indicates that the first row consists of column names. ‘sep=","’ code separates columns in the table by commas. > #Imports dataset into R and assigns as ‘x’ > x=read.table(file.choose(),header=TRUE,sep=",") > x         Name Age    Sex Grade 1       Raul  25   Male    80 2     Booker  18   Male    83 3      Lauri  21 Female    90 4     Leonie  21 Female    91 5    Sherlyn  22 Female    85 6    Mikaela  20 Female    69 7 ...
                                            Read more

                                            PACKAGE "ACCURACY"

                                                 Introduction:    ✔  Diagnostic tests play a very crucial role in contemporary medical practice as it allows the medical practitioner to rule out the disease and diagnose disease in patients who have an illness.  Clinicians need insight into the possibility that an individual has a condition to arrive at therapeutic choices and give personalized treatment. This requires integrating knowledge of preliminary chance with diagnostic tests.   ✔ In order to decide on possibilities for therapy, medical diagnostics are frequently used for medical systems; moreover, numerous of these strategies need to be more accurate.  Documentation must be utilized to inform the use of evaluations for diagnosis in healthcare situations.  But regrettably, several clinicians conduct diagnostic tests without incorporating the supporting data.   ✔  Sensitivity and specificity are very crucial indicators for the accuracy of the diagnost...
                                            Read more

                                            Visualization of Graphics in R

                                            Image
                                            To understand graphics in R, initially dataset is selected to understand it.  The dataset 'measles' is downloaded from the following link:  https://vincentarelbundock.github.io/Rdatasets/datasets.html The dataset 'measles' is imported  in R by clicking on import dataset option below the environment tab in Rstudio followed by appearanace of dialog box to choose data set from downloads. To produce graphics in R, there are three types: 1. Base graphics 2. Lattice 3. ggplot2 1. Base graphics: Base graphics already exists in the R installation. It allows to create a wide range of two dimensional plots, including scatterplots, line graphs, bar graphs, and more. > plot(measles,pch=21,col=rainbow(12),main= " Deaths in London from measles", cex=1.0) > plot(measles,pch=21,bg="green",col=cm.colors(12),main= " Deaths in London from measles", cex=1.0) 'plot' function  is implemented  which creates scatterplot of a dataset. 'pch=21'...
                                            Read more