Pull Request: Submit vignette for Feature computations 20240916

andreabringhurst commented 2 months ago

Description This pull requests that we add a new vignette to utDataStoR - computations. This vignette describes each of the computations in the utMetrics package organized by the type of computation (count, rate, sum) and describes how the year works for each computation category. The utMetrics package is private, so placing this vignette in utDataStoR allows it to be placed in a public bookdown.

Changes Made Added a new vignette titled "computations" Includes the following: A description of each computation organized by the type of computation (count, rate, sum) A description of how the year works for each computation category.

Motivation and Context The goal of this vignette is to describe how each computation is calculated and to describe how the year works for each computation category.

How Has This Been Tested? The vignette has been reviewed for clarity and accuracy by the Office of Institutional Effectiveness. All code examples have been tested to ensure they produce the expected results.

Styling The styling of this vignette has been reviewed and approved by the Office of Institutional Effectiveness.

Types of Changes

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

[x] My vignette follows the style guidelines provided in the README for this repository
[x] I have performed a self-review of my own code, including knitting the vignette
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have reviewed my .gitignore file to ensure the exclusion of items we do not want included in a commit history
[x] My vignette does not include any sensitive data

Additional Notes

andreabringhurst commented 1 month ago

@MattNickodemus please review this vignette today as discussed in morning huddle.

MattNickodemus commented 1 month ago

@cdemkegit This is ready to be merged whenever you're ready.

cdemkegit commented 1 month ago

I'm merging this to dev

ut-effectiveness / utDataStoR

Pull Request: Submit vignette for Feature computations 20240916 #28