Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Release v0.5.0 #13

Merged
merged 23 commits into from
Aug 15, 2024
Merged

Release v0.5.0 #13

merged 23 commits into from
Aug 15, 2024

Conversation

dbrakenhoff
Copy link
Collaborator

The biggest change is that there are now two options for corrections:

  1. Return corrections as a series containing NaNs where values are marked as suspect and removed, and containg values where the observations are shifted, such that validated_series = raw_series + corrections. This is the original implementation.
  2. Return corrections as dataframe containing a correction code, the series value used for comparison, and the value that is compared with. This allows more insight into the reason why obserations are flagged as suspect, and what the criteria are that it has to deal with.

Furthermore, this PR contains lots of improvements to the code and documentation, some bugfixes to error detection rules, and better testing, formatting etc.

dbrakenhoff added 17 commits May 16, 2024 11:32
@dbrakenhoff
use solver attribute instead of deprecated .fit
57f9e4b
@dbrakenhoff
Rewrite rules to use CorrectionCodes
e6ea78a 
- get insight into reason for flagging observation as suspect
- modify corrections to be dataframe with correction codes, series values and comparison value.
- keep previous nan-based corrections working
@dbrakenhoff
update notebooks and docs
c07340b
@dbrakenhoff
sort imports
34bd9f7
@dbrakenhoff
add notebook showcasing current rules
6986845
@dbrakenhoff
update ci
2da1db5
@dbrakenhoff
update tests
bd20f64
@dbrakenhoff
documentation
eb3c0da
@dbrakenhoff
up version
bb96381
@dbrakenhoff
update rtd yml w new python version
27b0d48
@dbrakenhoff
add ruff logic to pyproject.toml
3534f58
@dbrakenhoff
update readme
7ae325e
@dbrakenhoff
Merge pull request #12 from ArtesiaWater/corrections
05b84d8 
Add option to get more information about corrections
@dbrakenhoff
ignore some ruff rules for now
0acd1ce
@dbrakenhoff
ruff
c1ab114
@dbrakenhoff
ruff
dd2eb50
@dbrakenhoff
fix warnings
bc666b7
@dbrakenhoff dbrakenhoff requested a review from rubencalje July 23, 2024 11:57
@dbrakenhoff dbrakenhoff self-assigned this Jul 23, 2024
@dbrakenhoff dbrakenhoff requested a review from martinvonk July 23, 2024 15:26
martinvonk
martinvonk approved these changes Jul 24, 2024
View reviewed changes
Copy link
Collaborator

@martinvonk martinvonk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not qualified to check this but the code looks clean and nice so 👍

@dbrakenhoff dbrakenhoff merged commit 9577964 into master Aug 15, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@martinvonk martinvonk martinvonk approved these changes

@rubencalje rubencalje Awaiting requested review from rubencalje

Assignees

@dbrakenhoff dbrakenhoff

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dbrakenhoff @martinvonk