Pull Request: Submit vignette for Feature utmetrics 20240916

andreabringhurst commented 2 months ago

Description This pull requests that we add a new vignette to utDataStoR. This vignette gives a general overview to the utMetrics package for Utah Tech University. The utMetrics package is private, so placing this vignette in utDataStoR allows it to be placed in a public bookdown. The vignette describes how a metric name is derived, and describes each of the components: Season and Year, Computation, Partition, and Segments.

Changes Made Added a new vignette titled "utMetrics" Included detailed explanations of the following: How a metric name is derived Describes each of the components of a metric name : Season and Year, Computation, Partition, and Segments

Motivation and Context The goal of this vignette is to give an overview of utMetrics, how it can be used, what metrics are available, and give some examples of partitions and segments.

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 I really need you to review this pull request today. You said in morning huddle that if you didn't you would buy us all lunch!

MattNickodemus commented 1 month ago

This looks good to me. @cdemkegit Whenever you are ready, let's go ahead with this pull request.

cdemkegit commented 1 month ago

I merge this to dev branch

ut-effectiveness / utDataStoR

Pull Request: Submit vignette for Feature utmetrics 20240916 #25