In evelynsugi/weatherapi: Package to wrap the Weather API

Daily Log Notebook

February 13, 2022

What I did for the project:

1. Read project requirements and resources
2. Looked at some API candidates for the project
3. https://www.programmableweb.com/api/omdb-rest-api-v1
4. https://www.wordsapi.com/
5. https://weatherapi.com/

Role in the bigger group picture:

Suggested some API for the group members to consider.

Links to the github commits:

The group GitHub repository is not created yet.

February 14, 2022

What I did for the project:

1. Looked at the documentation more closely for the three API candidates. Sign-up to get the API key for the APIs.
2. Had a meeting with the team members to discuss which API to use for the project.
3. The team decided to move forward with the Weather API as the the interface of the API is convenient to use and comprehend
4. Each team member will write one function each for the package (from start to finish)
5. Setup the project directory structure so that the package is more organized.
6. Wrote one function (get_current_weather) and its documentation.
7. Wrote a function to set the api key (api_key) to be used in the other functions along with its documentation.
8. Added two more functions (get_time_zone and get_sports_events) to get the time zone and sports events of a location and its documentation.

Role in the bigger group picture:

Attended group meeting and suggested some API to work with. Wrote three main functions for the package and a function to set the API (to be used in other functions in the package). Set up the project directory for the package so that the repository is more organized.

Links to the github commits:

• https://github.com/xintian927/534-proejct/commit/28a04a7d21743093d2308a65fafb2221a7024486
• https://github.com/xintian927/534-proejct/commit/ef92615d323694671c3a72ae3962d58c72de5750

February 15, 2022

What I did for the project:

1. Added unit tests to test the get_current_weather, get_time_zone, and get_sports_events functions
2. Modify the DESCRIPTION file to describe the package

Role in the bigger group picture:

Added unit tests to ensure that the function works properly inside the weather api package.

Links to the github commits:

https://github.com/xintian927/534-proejct/commit/de91064f0fae22a14524602ad4db768830c8486c

February 16, 2022

What I did for the project:

1. Reorganized the functions (one R file for each function) so that it is easier to search through the source code
2. Added inline comments to make the source code easier to understand
3. Added vignette for the package:
4. Setup
5. Error Codes
6. Functions: api_key, get_current_weather, get_time_zone, get_sports_events
7. Plots: Plot temperature for different locations and Plot local time zone of different locations in world-map
8. Minor revision on the documentation of api_key (adding examples to the documentation and vignette)

Role in the bigger group picture:

Made it easier for users of the package to understand and search through the source code by reorganizing the functions and adding inline comments, documentation, and vignette for the package.

Links to the github commits:

https://github.com/xintian927/534-proejct/commit/a34d5baab6b59c149640579ad70ec54ec571de6c https://github.com/xintian927/534-proejct/commit/d9a13ba6a3a0541ec83e45903ef008fe56592ded

February 17, 2022

What I did for the project:

1. Had a meeting with the other team members to merge our codes together. We each create a pull request for our branch and have the other team members review and/or solve the conflicts.
2. We did a test run on our package to see if we can install it in our computer through devtools::install_github() and solve any problems that we encouter.
3. Fixed the vignette builder as it was not displaying the vignette when we install the package to our computer.

Role in the bigger group picture:

As a group, we merged all our branches together to create a fully functioning package.

Links to the github commits:

https://github.com/xintian927/534-project/commit/90e3d42822bf67bd12e6462968fd87643e9778b9 https://github.com/xintian927/534-project/commit/54390421bfdb5c1666c21a46111d8757c86b6265

February 18, 2022

What I did for the project:

1. Had a meeting with the other team members to go through the steps to implement circle ci for R packages.
2. Fixed problems related to build issues:
3. Incorrect license file type (changed License.md to license)
4. Added missing packages to the imports and suggests section in the DESCRIPTION file (devtools, ggplot2, reshape2, maps, tidyverse)
5. Renamed files with non-portable file names (code of conduct.md to CODE_OF_CONDUCT.md)
6. Fixed functions (get_astronomy and api_key) that was causing errors.
7. Added unit test for api_key function.

Role in the bigger group picture:

Prepared the package so that it is error-free during the build process which is an essential step prior to circle ci. All team members gather in a zoom call to go through the circle ci configuration and gotten a passing badge for our package in circle ci.

Links to the github commits:

https://github.com/xintian927/534-project/commit/8210db34338938927f558cb595a6b0d7a6fecdca https://github.com/xintian927/534-project/commit/2aca45296b801df2c7de1caf586d95b3c41980e2 https://github.com/xintian927/534-project/commit/cc9a3c7ec6fea19171cee9e00f0f2744f1fe8ddc

evelynsugi/weatherapi documentation built on April 7, 2022, 12:43 p.m.