R repository setup

CONDUCT.md

@@ -0,0 +1,48 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Our team members are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. The current team members are:
+
+Rubén De la Garza Macías
+Helin Wang
+Allyson Stoll
+Song Bo Andy Yang
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant homepage](http://contributor-covenant.org/version/1/4), version 1.4.

CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+## Types of Contributions
+
+### Report Bugs
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+### Write Documentation
+
+You can never have enough documentation! Please feel free to contribute to any
+part of the documentation, such as the official docs, docstrings, or even 
+on the web in blog posts, articles, and such.
+
+### Submit Feedback
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `olympic-dash` for local development.
+
+1. Fork the `olympic-dash` repo on GitHub.
+
+2. Clone your fork locally.
+
+    ```
+    git clone git@github.com:your_name_here/olympic-dash.git
+    ```
+
+3. Use `git` (or similar) to create a branch for local development and make your changes:
+
+    ```console
+    $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+4. Commit your changes and open a pull request.
+
+    ```
+    git add .
+    git commit -m "Your detailed description of your changes."
+    git push origin name-of-your-bugfix-or-feature
+    ```
+
+5. Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+-   We recommend that you push to your fork repo and then initiate a
+    pull request (PR).
+-   New code should follow the tidyverse [style
+    guide](http://style.tidyverse.org) or PEP8 [style
+    guide](https://www.python.org/dev/peps/pep-0008/).
+
+## Code of Conduct
+
+Please note that this project is released with a [Contributor Code of
+Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree
+to abide by its terms.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Master of Data Science at the University of British Columbia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,90 @@
+# olympic-dash
+
+_**An interactive dashboard illustrating historic olympic data and trends**_
+
+## Welcome!
+
+Thank you for visiting the olympic-dash project repository!
+
+This README file is a hub to give you some information about the project. Jump straight to one of the sections below, or just scroll down to find out more.
+
+* [What Are We Doing?](#what-are-we-doing)
+* [Description of The Dashboard](#description-of-the-dashboard)
+* [Proposed Sketch](#proposed-sketch)
+* [Contribute to This Dashboard](#contribute-to-this-dashboard)
+* [Contributors](#contributors)
+* [Code of Conduct](#code-of-conduct)
+* [License](#license)
+
+## What Are We Doing?
+
+> “The goal of the Olympic Movement is to contribute to building a peaceful and better world by educating youth through sport practiced without discrimination of any kind and in the Olympic spirit, which requires mutual understanding with a spirit of friendship, solidarity and fair play.” 
+> 
+> -- <cite>International Olympic Committee</cite>
+
+We propose building a visualization app to allow IOC members (and members of the general public) to explore historical Olympic results to review the success trends of various countries to determine abnormal performance trends and which countries could be future high medal achievers. All in the interest of making the olympic games more competitive and reward the countries that are developing their athletes and improving their performance in the games.
+
+## Description of The Dashboard
+
+To explore the current dashboard, please click [here](https://olympic-dash-dsci532-group22-p.herokuapp.com/).
+
+This app contains a dashboard which visualizes Olympic data from 1896 up until 2016. 
+Key metrics of interest will be displayed including: 
+- Medals earned per country
+- Medals earned depending on athlete age
+- Athlete height based on Olympic events 
+- Medals per country will be displayed 
+
+Medals earned per country will be displayed via a bubble chart accompanied by a 
+slider, allowing users to control the year of the Olympics displayed by the graph. 
+
+A bar chart will show the medals earned for each athlete age bracket, while a histogram 
+will show the distribution of athlete heights based on the event selected. These figures 
+will contain a slider allowing users to adjust athlete age ranges and a dropdown list, 
+allowing users to select the event visualized respectively. 
+
+Lastly, a line graph will display the number of medals earned by countries over time. This 
+figure will be accompanied by a dropdown list allowing users to select a subset of countries 
+to display on the graph. 
+
+Radio buttons on the side of the dashboard will allow for filtering of 
+summer/winter Olympics data, in addition to allowing for users to filter data 
+by the type of medals. Using these filters, users will be able to investigate trends 
+in Olympic success between countries, medal types, athlete demographics, and more.
+
+## Proposed Sketch
+
+![Alt text](img/olympic-dash-proposal.png?raw=true "Dashboard Proposal")
+
+## Contribute to This Dashboard
+
+You are welcome to contribute to olympic-dash if you have any idea regarding to this dashboard. Please go through the [contributing guidelines](CONTRIBUTING.md) for the recommended ways if you want to contribute or report/fix any existing bugs.
+
+### How to install and run locally
+
+To run the dashboard locally, we recommend to use a virtual environment like [venv](https://docs.python.org/3/library/venv.html) or [Anaconda](https://www.anaconda.com/). For simplicity, we could demonstrate the installiation process with venv.
+
+#### Setup
+
+Run the following command at the root directory of the project:
+
+
+## Contributors
+
+This app was developed by the following contributors:
+
+|  Contributor  |  Github Username |
+|--------------|------------------|
+|  Allyson Stoll |  @datallurgy |
+|  Helin Wang |  @helingogo  |
+|  Rubén De la Garza Macías  |  @ruben1dlg |
+|  Andy Yang  |  @AndyYang80  |
+
+## Code of Conduct
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+For more details, see our [code of conduct.](CONDUCT.md)
+
+## License
+
+`olympic-dash-R` was created by Allyson Stoll, Helin Wang, Rubén De la Garza Macías and Song Bo Andy Yang . It is licensed under the terms of the MIT license.