CHANGELOG

v3.0.0 (2024-02-03)

Breaking

  • feat!: release 3.0.0 BREAKING CHANGES: finished the requirements of milestone 4, and ready to submit (8cab63c)

Unknown

  • Merge pull request #101 from UBC-MDS/release

feat!: release 3.0.0 (fd6739c)

  • Merge pull request #99 from UBC-MDS/adjust_readme

adjusted the README a little bit (adf5e05)

v2.0.12 (2024-02-02)

Fix

  • fix: Feedback addressed by adding a test for the if raise clause in plot_missing_vals (f8df94b)

Unknown

  • Merge pull request #100 from UBC-MDS/plot_missing_vals_tests_edit

fix: Feedback addressed by adding a testing the edge case in plot_missing_vals (1e7e424)

  • Merge branch ‘main’ into plot_missing_vals_tests_edit (853e2b7)

  • adjusted the README a little bit (743d1e9)

v2.0.11 (2024-02-02)

Fix

  • fix: Feedback addressed by adding instructions for cloning repo by HTTP (a317e47)

Unknown

  • Merge pull request #98 from UBC-MDS/install_instructions_edit

fix: Feedback addressed by adding instructions for cloning repo by HTTP (d39842f)

  • resolved merge conflict from main (9f490ed)

v2.0.10 (2024-02-02)

Fix

  • fix: address feedback by modifying the package description (ad89d35)

Unknown

  • Merge pull request #97 from UBC-MDS/readme

fix: address feedback by modifying the package description (ceb742e)

  • include more examples on unit tests (51306b5)

  • Merge branch ‘main’ into readme (3749c7c)

v2.0.9 (2024-02-01)

Unknown

  • Merge pull request #95 from UBC-MDS/update_generate_return_series

Update generate return series (0058a5e)

v2.0.8 (2024-02-01)

Unknown

  • Merge pull request #91 from UBC-MDS/plot_test_edge_case

Fixed issue with plot_num_dist tests (7204bad)

v2.0.7 (2024-02-01)

Fix

  • fix: address feedback by improving test coverage in generate_return_series (1f8802d)

  • fix: feedback addressed by improving test coverage and docstrings for generate_financial_metrics (aaa15dc)

Unknown

  • Merge pull request #93 from UBC-MDS/financial_metrics

fix: feedback addressed by improving test coverage and docstrings for generate_financial_metrics (b07151a)

  • Update README.md

Small formatting error with image (d26f060)

v2.0.6 (2024-02-01)

Fix

  • fix: address feedback by removing unnecessary variables in function (9f83726)

  • fix: address feedback by removing cookicutter (d3c5ff3)

Unknown

  • Merge pull request #92 from UBC-MDS/remove_unnecessary_dependencies

fix: address feedback by removing cookicutter (9819665)

v2.0.5 (2024-02-01)

Fix

  • fix: Addressed feedback by adding more extensive testing to test_plot_num_dist (21aca28)

  • fix: Feedback addressed by adding additional test for numeric dataframe and fixing regex mismatch (0d908e1)

Unknown

  • Merge pull request #87 from UBC-MDS/readme

fix: Feedback(3) addressed by adding installation guide, adding example in usage and providing basic definition to outputs on README (74dfbde)

v2.0.4 (2024-02-01)

Fix

  • fix: updated commands and code quotations (948e297)

  • fix: updated command to be copy-able

Co-authored-by: Merete Lutz <143561866+meretelutz@users.noreply.github.com> (8ff99a7)

Unknown

  • Merge pull request #89 from UBC-MDS/readme_structure

fix: Addressing feedback by adding description and python ecosystem s… (2ce8ac6)

v2.0.3 (2024-02-01)

Fix

  • fix: Addressing feedback by adding description and python ecosystem subheader (0ca0879)

  • fix: refresh example.ipynb in quanteda env (b866ccd)

  • fix: feedback addressed by adding definitions to financial metrics (006b1ec)

  • fix: Feedback(3) addressed by Doris

  • added package installation section

  • updated usage section to include example of how

  • updated summary section to provide basic definitions to the output financial metrics (db13b41)

Unknown

  • Merge pull request #88 from UBC-MDS/docs

fix: feedback addressed by adding definitions to financial metrics on Vignette (747c354)

  • Merge pull request #83 from UBC-MDS/badges

Feedback: Added repostatus badge to readme (c0e6066)

  • Feedback: Added repostatus badge to readme (04b8439)

v2.0.2 (2024-01-30)

Fix

  • fix: correct changelog version number (22c6cb4)

Unknown

  • Merge pull request #68 from UBC-MDS/correct_changelog

fix: correct changelog version number (524c6b5)

v2.0.1 (2024-01-30)

Build

Fix

  • fix: add release token for the CD (f1f1c31)

  • fix: removed unnecessary test_quanteda.py (4e3e3cc)

  • fix: employ the most updated pyproject.toml from cookicutter (b451c3a)

  • fix(ci-cd.yml): employ the most udpated file from cookicutter (650f4d5)

Unknown

  • Merge pull request #67 from UBC-MDS/setup_cicd

fix: add release token for the CD (4b4a1bd)

  • Merge pull request #66 from UBC-MDS/badges

Adding Badges to Readme (a1b9ab8)

  • other badges added (44f8bfb)

  • Merge pull request #65 from UBC-MDS/add_logo

Added package logo (cd51954)

  • Docs badge added (28e4f66)

  • Added package logo to conf file in docs and added logo file in new img folder (2db051f)

  • Merge pull request #64 from UBC-MDS/setup_cicd

Setup CI/CD (c1d8536)

  • Merge branch ‘main’ into setup_cicd (79c763b)

  • Merge pull request #61 from UBC-MDS/meretelutz-patch-1

feedback: delete tests/test_quanteda.py (d2c19c3)

  • feedback: delete tests/test_quanteda.py (e5e246c)

  • Merge pull request #56 from UBC-MDS/changelog

Updated Changelog (5656870)

  • updated CHANCELOG (4ab70e6)

  • updated CHANGELOG (7f40e03)

  • Merge pull request #54 from UBC-MDS/build_doc

Update .readthedoc.yml (8b096e3)

  • adjusted tutorial title, and fixed .readthedocs.yml (2794d53)

  • merged main (0ce3451)

  • added documentation-related dependence (9db7e75)

  • Merge pull request #50 from UBC-MDS/plot_missing_vals_edit

Plot missing vals edit (1e3ecf8)

  • Merge pull request #53 from UBC-MDS/vignette_edit

Vignette edit (2cc051c)

  • added headers in the example (d26bc3a)

  • Merge pull request #46 from UBC-MDS/vignette_draft

Vignette draft (f1c3356)

  • Merge pull request #49 from UBC-MDS/feedbacks

Addressing Feedbacks from Milestone1 (701247c)

  • Merge pull request #47 from UBC-MDS/readme_documentation

Documentation subheader and link added to README (7a57a19)

  • Reviewed and edited example.ipynb to improve concisiveness (305e0a4)

  • Have to commit changes but will delete this branch (c4c7748)

  • Updated function’s docstring to remove the term tick chart as per milestone 1 feedback (f1c1aba)

  • removed empty file based on feedback (93ac16d)

  • updated docstring based on milestone1 feedback (b975efc)

  • Documentation subheader and link added (38b4cc7)

  • refreshed example.ipynb (4edcb6f)

  • updated raw data files adapted with new functionality (bb31cd5)

  • added functionality to download zip from url (859b970)

  • added jupyter lab to env on pyproject.toml (c3cf90f)

  • added the raw data file (fb6a008)

  • added the vignette draft (61d0aa3)

  • Merge pull request #39 from UBC-MDS/hotfix_env

fixed the typo in environment.yml (964b864)

  • fixed the typo in environment.yml (5e68de2)

  • Merge pull request #36 from UBC-MDS/update_docs

Update docs (8117c9c)

  • resolved merge conflict (f6a0de6)

  • included coverage reporting pytest usage (aae480e)

  • Merge pull request #38 from UBC-MDS/env_yml

Added test coverage dependency (ce0a2e8)

  • Merge branch ‘update_docs’ of github.com:UBC-MDS/quanteda into update_docs (8fee4f0)

  • updated the README based on tiff suggestion (00a7b05)

  • poetry.lock merge conflict (ad69083)

  • Merge conflict with poetry.lock (bc32c4c)

  • Update CHANGELOG.md

Co-authored-by: Merete Lutz <143561866+meretelutz@users.noreply.github.com> (c059d75)

  • Merge pull request #37 from UBC-MDS/missing_vals_body

Missing vals body (3f6c624)

  • Deleting testing file (5859bec)

  • updated the changes from missing_vals_body branch (020af18)

  • aligned the docstring format (9bc24e1)

  • Merge conflict with poetry.lock (90ff0ad)

  • Added pytest-cov as dependecy (fa54405)

  • Ready to create pull request and merge (f0d4b77)

  • Trying to make the fixture request work (c1ff7e8)

  • Merge branch ‘main’ into missing_vals_body (cfa7394)

  • Created test_plot_missing_vals file (e35add4)

  • Merge branch ‘update_docs’ of github.com:UBC-MDS/quanteda into update_docs (12c999b)

  • removed poetry.lock for reproducibility (ec96cce)

  • Update README.md (dfdcfd1)

  • added missing instruction in README (3c3ff64)

  • added missing instruction in README (16ddae6)

  • updated CHANGELOG (cec5778)

  • updated README to include testing instruction (02cee73)

  • Merge branch ‘main’ into update_docs (a73402d)

  • refactored environments (86d502d)

  • Merge pull request #33 from UBC-MDS/modify-test_generate_return_series.py

fixed bugs in test case (67557dc)

  • Merge pull request #35 from UBC-MDS/plot_num_dist

Tests and function body for plot_num_dist (a9fb00e)

  • Added docstrings to tests (4f1bd37)

  • Removing import of plot_num_dist (fea21d3)

  • Tests running, plot not in conftest (17349ae)

  • Tests are working (546bd73)

  • Merge branch ‘main’ into plot_num_dist (739e21b)

  • Create plot object for tests (d2ea0f4)

  • tests/conftest.py (97ef273)

  • Merge pull request #34 from UBC-MDS/financial_metrics

[generate_financial_metrics] Write unit tests and function body (185a37a)

  • Update tests/test_generate_financial_metrics.py

agreed

Co-authored-by: JohnShiuMK <asbjchk@yahoo.com.hk> (2e55dc6)

  • Update tests/test_generate_financial_metrics.py

agreed

Co-authored-by: JohnShiuMK <asbjchk@yahoo.com.hk> (2217409)

  • Update src/quanteda/generate_financial_metrics.py

agreed

Co-authored-by: JohnShiuMK <asbjchk@yahoo.com.hk> (8d049f3)

  • Update src/quanteda/generate_financial_metrics.py

agreed

Co-authored-by: JohnShiuMK <asbjchk@yahoo.com.hk> (9562ee7)

  • Update src/quanteda/generate_financial_metrics.py

agreed

Co-authored-by: JohnShiuMK <asbjchk@yahoo.com.hk> (2b85e19)

  • tests: updated tests inputs (fd4b3fc)

  • tests for generate_financial_metrics (1a41af5)

  • func: generate_financial_metrics.py implementation (0fff7ad)

  • Missed an equal sign (9756ecc)

  • 5 tests written for test plot (3df8f16)

  • fixed bugs in test case (9c4c943)

  • First test written (d42d320)

  • Merge branch ‘main’ into plot_num_dist (d13f991)

  • Merge branch ‘main’ into plot_num_dist (fabcea9)

  • Merge pull request #31 from UBC-MDS/test_generate_return_series

create test data, unit tests and function body for generate_return_series (b7303a4)

  • Got rid of grouping parameter (3a50f1d)

  • Work after peer coding (439f44d)

  • Update src/quanteda/generate_return_series.py

Co-authored-by: Merete Lutz <143561866+meretelutz@users.noreply.github.com> (fbd9782)

  • Update tests/test_generate_return_series.py

Co-authored-by: Merete Lutz <143561866+meretelutz@users.noreply.github.com> (de912a0)

  • Adding new parameter for grouping (2ff0b17)

  • Exception handling (c55e97f)

  • First pass at function body (88cf03a)

  • added docstring to the tests (c826c97)

  • created test data for other functions (f67976c)

  • added pytest in environment (39d6ffa)

  • added negative vol error handling (990b44a)

  • fixed comments in tests (073c7ee)

  • finished function body (6445e77)

  • updated test functions (cf6271d)

  • draft test functions (6158395)

  • Merge pull request #26 from UBC-MDS/readme

Added contributors section to readme (62a1b9f)

  • Accidentally added extra files (734cbef)

  • Adding contributors section to readme (47fbc22)

  • Merge pull request #25 from UBC-MDS/plot_missing_vals

Plot missing vals (a205b7c)

  • Merge pull request #21 from UBC-MDS/env_yml

Added packages to environment.yml (551c1a6)

  • Update src/quanteda/plot_missing_vals.py

Co-authored-by: Merete Lutz <143561866+meretelutz@users.noreply.github.com> (2682864)

  • Update src/quanteda/plot_missing_vals.py

Co-authored-by: Merete Lutz <143561866+meretelutz@users.noreply.github.com> (f27801b)

  • Finished plot_missing_vals documentation (274c5c6)

  • Merge pull request #24 from UBC-MDS/plot_num_dist

Docstring for plot_num_dist function (6002746)

  • Merge pull request #23 from UBC-MDS/readme

Readme summary of package (2b7da15)

  • Missed a period (ce99228)

  • Added specifics to missing values function (a6e0841)

  • Finished docstring, might need to edit example (a60da89)

  • Added specifics for histogram function (171461d)

  • Added altair to environment file (49e10f7)

  • Initial docstring framework (24afb84)

  • Merge pull request #20 from UBC-MDS/financial_metrics

Adding financial metrics function (5bedb98)

  • Added metric function name/description (f355da1)

  • Improved paragraph explaining gap (f87cd45)

  • Initial descriptions of functions - need to finalize (059b5a7)

  • Finish paragraph explaining place among other packages (c8e1d9e)

  • Update src/quanteda/financial_metrics.py

agreed as well. Thanks for the adjustments

Co-authored-by: JohnShiuMK <asbjchk@yahoo.com.hk> (b3899e2)

  • Update src/quanteda/financial_metrics.py

agreed.

Co-authored-by: JohnShiuMK <asbjchk@yahoo.com.hk> (5fcea60)

  • Update src/quanteda/financial_metrics.py

agreed

Co-authored-by: JohnShiuMK <asbjchk@yahoo.com.hk> (a379972)

  • Update src/quanteda/financial_metrics.py

agreed

Co-authored-by: JohnShiuMK <asbjchk@yahoo.com.hk> (f30209c)

  • Update src/quanteda/financial_metrics.py

agreed.

Co-authored-by: JohnShiuMK <asbjchk@yahoo.com.hk> (59117d8)

  • Skeleton of intro paragraphs (2173da4)

  • Merge pull request #18 from UBC-MDS/feat_random_time_series

Feature: generate random time series (006cd22)

  • fixed typo (5372878)

  • Created plot_missing_vals file and outline of function and docstring (b0a2801)

  • bug - added numpy and pandas package to env yml file (5f4ac88)

  • feat-adding financial metrics function (c46b2ad)

  • feat-adding financial metrics function (770e1f8)

  • modified the docstring (49435ca)

  • Update src/quanteda/generate_return_series.py (70b8805)

  • Update src/quanteda/generate_return_series.py (d7973fe)

  • Update src/quanteda/generate_return_series.py (465f5e3)

  • Update src/quanteda/generate_return_series.py (f86e691)

  • revised the docstring into pandas format (edd591e)

  • draft function (8fd7ee9)

  • initial package setup (b6691a2)