README.md

In liamg15/ezTools: What the Package Does (One Line, Title Case)

ezTools

The purpose of ezTools is to address missing values in data sets and to perform basic statistical analyses such as those that were required for my Master’s Thesis project at the University of British Columbia. The functions are simple and easy to use for data frames, appropriately wrapped in a package called ezTools.

Link to repository: https://github.com/liamg15/ezTools

Use ezTools to:

• Modify missing numeric values in datasets in preparation for run what-if analyses, or to introduce randomness
• Perform basic statistical analyses using parametric and non-parametric methods

NOTE: This package is very young. There are more functionalities coming soon.

Basics of ezTools

library(ezTools)

Imagine you are creating a data frame with both numeric and character variables, but some numeric inputs have missing values.

Example:
 df <-tibble(
  first = c("a", NA, "b", "c","d"),
  second = c(NA, 2, NA, 3, 4),
  third = c(10, NA, NA, 5, 6)
 )

To deal with missing values when modelling, one can simply remove or ignore them (e.g na.rm = TRUE), in which case the NA values are forgotten. Now, what if you wanted to see the impact of changing them all to the mean and fit a model to this new distribution? NA2x() provides an easy and effective way to deal with missing numeric values.

NA2x(df)

# A tibble: 5 x 3
 first     second third
 <chr>      <dbl> <dbl>
 1 a          3    10
 2 NA         2     7
 3 b          3     7
 4 c          3     5
 5 d          4     6

The main function of NA2x is to convert missing values to the mean, but other statistics can be specified like replacing NAs with the median such as for non-parametric analyses.

NA2x(df, fun = median)
# A tibble: 5 x 3
 first     second third
 <chr>      <dbl> <dbl>
 1 a          3    10
 2 NA         2     6
 3 b          3     6
 4 c          3     5
 5 d          4     6

Installation

You can install the released version of ezTools from CRAN with:

devtools::install_github("liamg15/ezTools")

Notes

ezTools should not be used to optimize the distribution to fit data. It’s simply a tool to answer what-if style questions.

Assignment 2B Exercise Explanations

Exercise 1

The function I created from Assignment 1B was wrapped in this package.

Exercise 1.1

1. Load devtools and roxygen2 (install it if needed)

library(devtools)
library(roxygen2)

1. Create package path

create_tidy_package("C:/Users/Goldi/Documents/Packages/assignment2")

1. Use Git

use_git()
1: Yes
2: Yes

1. Wrote first function

use_r("NA2x")

1. Test that function works

load_all()

df <-tibble(
 first = c("a", NA, "b", "c","d"),
 second = c(NA, 2, NA, 3, 4),
 third = c(10, NA, NA, 5, 6)
)

NA2x(df)

1. Add packages to ezTools

use_package(magrittr, type = "Imports")
use_package(dplyr, type = "Imports")
use_package(glue, type = "Imports")

In function:
@import glue
@import dplyr
@importfrom magrittr %>%

1. Create test that for NA2x

use_testthat()
use_test("NA2x")
Manual: Created an R script called NA2x_tests (tests/testthat) and input test functions from Assignment 1B.

1. Add required packages to this package

Manual: In NAMESPACE, added @import tidyverse and @import glue. In DESCRIPTION, added imports and depends for both packages.

1. Run a check to see if package has any errors, notes or warnings

check()

1. Create a license

use_mit_license()

1. Make function roxygen2-friendly to create the reference for NA2x.

Add #' in function file
Select any part of function then > Code > 'Insert roxygen2 skeleton'

1. Added a code of conduct

use_code_of_conduct()

1. Make a website for package

library(pkgdown)
use_pkgdown()
pkgdown::build_site()
On GitHub: GitHub repository > Settings > GitHub Pages > Source > Main > Save

Exercise 1.2

Created test functions based on assignment 1B. 1. test that NA2x does not work on character vectors, 2. check that returns message when verbose = TRUE.

Exercise 1.3

All objects are @exported in this package. The justification for this is to make all functions available to the public once the repository is published.

All functions: @export(NA2x) - This function requires glue and tidyverse to work, so these packages are required. Glue is a small package so it’s imported with ezTools. ezTools is dependent on tidyverse but since this package is large and updated frequently, it’s added as a dependent package. - By adding these packages into the description components of this package I can create new functions which depend on the same functionalities that can be easily added without modifying the code with ::. This will reduce the chances of making minor mistakes (e.g repetitively using tidyverse:: to use functions from other packages). - A simple vignette was made to help the users perform the function properly.

Bonus A generic code of conduct was added to the repository. The package website can be found at . Badges were added to this package. A News.md fle can be found in the main repository.

liamg15/ezTools documentation built on Jan. 1, 2021, 8:19 a.m.