Building an R Package for Student Data Analysis: Final Project

GitHub: https://github.com/nbrown022/gradeTools-package.git

 For this project, I created an R package designed to perform basic data analysis tasks on student data. The goal of the package is to provide simple, easy-to-use functions that can clean data, calculate averages, generate summary statistics, visualize values, and identify maximum scores.

The package includes several functions that each serve a specific purpose. The clean_data() function removes missing values from a dataset, which is important for ensuring accurate analysis. The calc_average() function calculates the mean of a numeric vector while ignoring missing values. The summary_stats() function provides a quick statistical overview of a dataset, including measures such as minimum, maximum, median, and quartiles. The max_score() function returns the highest value in a dataset, which can be useful for identifying top performance. Finally, the plot_grades() function creates a simple scatter plot to visualize relationships between two sets of numeric values.

To build this package, I used RStudio along with the devtools and roxygen2 packages. The functions were written in the R/ folder, and documentation was added using special comments above each function. Running devtools::document() automatically generated help files in the man/ folder and updated the NAMESPACE file. This process demonstrated how documentation and code are integrated in an R package.

The package is organized into a standard structure that includes folders such as R/ for functions and man/ for documentation, along with files like DESCRIPTION and NAMESPACE. These components allow the package to be easily shared and reused by others.

Overall, this project helped me understand how R packages are created, structured, and documented. It also showed how tools like GitHub can be used to manage and share code. Compared to writing standalone scripts, building a package provides a more organized and reusable way to work with data analysis functions.

Comments

Post a Comment

Popular posts from this blog

Module 5

Image
  This a 10 x 10 in R. Matrix A contains the numbers 1 - 100, and the Matrix B contains the numbers 1 - 1,000. The matrix() function arranges the numbers into rows and columns so they can be used to matrix calculations. By specifying nrow = 10, it tells R to place the numbers into 10 rows. Since there are 100 values total, R fill 10 columns automatically. That how you get the 10 x 10 square matrix. With the 1:1000, it creates a sequence from 1 to 1000. The matrix () functions arrange the numbers into 10 rows, since there is 1000 numbers total, R creates 100 columns (1000 / 10 = 100). So, B becomes a 10 100 matrix, which is rectangular rather than square. This matters since there is only square matrices and can have determinants and inverses. The rm() function removes all existing objects from memory and ensure that no old variables interfere with your results. 1 :100 created numbers from 1 to 100. These numbers were arranged into 10 rows, producing a 10 x 10 matrix for A. 1: 1000 c...
Read more

Assignment #10: Building Your Own R Package

Image
  The plot_summary() function is used to automatically generate visualizations for a dataset. It begins by loading the ggplot2 package, which is used for creating graphs. The function then separates the dataset into numeric and categorical variables using sapply() with is.numeric and is.factor . This allows the function to treat each type of data appropriately. For numeric variables, a loop is used to create histograms that display the distribution of values. For categorical variables, another loop creates bar charts to show the frequency of each category. Each plot is printed using print(p) , which ensures that the graphs appear immediately in the RStudio Plots pane without needing additional commands. The interactive_chart() function creates an interactive scatter plot between two selected variables. It loads both ggplot2 and plotly , where ggplot2 is used to build the initial plot and plotly adds interactivity. The function takes a dataset and two column names as inputs,...
Read more