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.

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

Write is_nondesc() to check whether variables are in non-descending order #28

Merged
merged 15 commits into from
Nov 19, 2021

Conversation

kelly-sovacool
Copy link
Member

@kelly-sovacool kelly-sovacool commented Nov 7, 2021

Similarly to close_enough(), I like to use is_nondesc() paired with the assertthat package to make sure that claims I make in a manuscript are true. If you re-run your code or a pipeline, numbers could change slightly, and you'll want to be sure that your overall conclusions did not change. For example, if I make a claim that "x is less than y and y is less than z", then I also include a hidden code chunk with assert_that(is_nondesc(x, y, z)).

Checklist

(Strikethrough any points that are not applicable.)

  • Write unit tests for any new functionality.
  • Update roxygen comments & vignettes if there are any API changes.
  • Update NEWS.md if this includes any user-facing changes.
  • The check workflow succeeds on your most recent commit.

@kelly-sovacool kelly-sovacool requested review from a team and sklucas and removed request for a team November 7, 2021 19:52
@kelly-sovacool kelly-sovacool marked this pull request as ready for review November 7, 2021 19:52
@sklucas
Copy link
Member

sklucas commented Nov 19, 2021

This sounds like a sound method for checking your work.

@sklucas sklucas merged commit e0a1270 into main Nov 19, 2021
@sklucas sklucas deleted the isnondesc branch November 19, 2021 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants