Module 10 Assignment

 Module 10 Assignment

Github Repository: https://github.com/christilly/readspeed/blob/main/DESCRIPTION

R package idea

    My idea for this R package is to glean fun and useful information from Goodreads data. Goodreads is a website/app for books where people can find new books track the books they read. People can download their Goodreads library directly from their accounts in the form of a CSV file. The CSV file contains the aforementioned information and more including ratings given to the books by the readers, books in the read and want to read sections of their accounts, IBSNs, and more. My idea is to create an R package where Goodreads users can upload their data and the program calculates the overall average time it takes for the user to finish a book, as well as the time it takes for the user to finish short, medium, and long books. This information can be useful for the user by giving an understanding of their reading habits. 

Creating the R package

    I used library(devtools) and create("readspeed") to create my package readspeed and it added the DESCRIPTION, R/, man/, and NAMESPACE files. Next, I used library(roxygen2) and roxygenise() so that the NAMESPACE file is automatically kept up-to-date. The result is shown below.

    I went into the Build tab and selected all the boxes for roxygen2 as seen below. 

DESCRIPTION file

    I followed the instructions on Canvas to fill out the description file with the necessary information. Here is how it looks: