/Riley

A working library of functions, data, color palettes (etc.) for everyday, and not-so-everyday, R tasks

Primary LanguageRGNU Affero General Public License v3.0AGPL-3.0

README

Riley Smith

24 April 2018

{Riley}: A fledgling R library (or set of libraries)

This is primarily an R-package built for personal reasons and is in the very early stages in terms of package development. I am primarily building this package as my personal starting point for learning the ins-and-outs of R-package development and version control with Git. However, in the interest of code-sharing and knowledge generation, I am making the development process public via this Github repository.

Currently, the functions and objects available in Riley/R/ are those that either I have written from scratch or those written by others which I have subsequently modified. Original source information regarding the latter category of functions is primarily only available in the source-code contained in Riley/R/SETUP.R. The contents of the Riley/man/ folder is severely lacking Rdocumentation files, which I am currently in the process of writing for each of the available functions in Riley/R/.

My ultimate goal with this is to create an R package containing tools (hopefullly) useful for implementing data analysis in mixed-methods research frameworks. I am developing the package under a methodological framework that values the unique importances, utilities, and natures of qualitative and quantitative data. Within this framework is an appreciation of and focus on the importance of data management, cleaning, and preparation for analysis and presentation. A large portion of the functions and processes I am working on for the package are thus focused on these back-end activities, in addition to data analytic tools for processing and transforming qualitative (With the help of the already existing RQDA package) and quantitative data in ways that speak to a truly mixed-methods analytic method. Additional components include tools for presenting data and analysis findings (and every step in between). These tools take advantage of the many, and growing, capabilities of Rmarkdown and knitr, and integrate styles inspired by Edward Tufte and the tufte R package.

Installation

Because the collective contents of this R-package remains a fledgling work in progess, installation of Riley is not currently recommended unless you are working with the primary author (@EccRiley or are in need of one or more of Riley's currently available functions and do not wish to re-write them yourself at the moment.

if (!require('devtools')) install.packages('devtools'); require('devtools')
devtools::install_github('EccRiley/Riley')

Package Updates and News

Any major updates to the package (i.e., changes that would prompt a revision to the above anti-installation warning) will be immediately reflected in this README.md document. However, in anticipation of frequent and abundant changes to the Riley in the near future, smaller updates will be recorded in NEWS.md.

To-Do

  • Initial package build
  • LICENSE file (create)
    • Add license to LICENSE file
  • DESCRIPTION file (create)
    • Add more descriptive description
  • [-] Code Optimization (& pruning) [IN PROGRESS]
    • [-] effficiency (vectorization, dependency reduction) [IN PROGRESS]
    • [-] usability (& usefulness)
    • [-] versatility [IN PROGRESS]
    • [~] consistency & reproducibility [PERPETUALLY IN PROGRESS]
  • [-] RDocumentation [IN PROGRESS]
    • examples
    • intra-library linkages
    • inter-library linkages
    • vignettes
    • statistical/mathematical explanations & justifications where appropriate
    • citations/credits throughout
  • Library/Library Set Design & Nomenclature:
    • "Rsmithing"? (for a sub-library focused on coding-specific utilities and linting (kind of like "word-smithing", but for R)?)