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

Improve documentation of smoothness() #519

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Improve documentation of smoothness() #519

wants to merge 4 commits into from

Conversation

DominiqueMakowski
Copy link
Member

@DominiqueMakowski DominiqueMakowski commented Jun 24, 2024 •
edited by etiennebacher
Loading

Close #374

etiennebacher
etiennebacher reviewed Jun 24, 2024
View reviewed changes
R/smoothness.R Outdated Show resolved Hide resolved
R/smoothness.R
Comment on lines +25 to +26
#' # When perfectly linear, the "smoothness" is 1
#' smoothness(1:10)
Copy link
Member

Choose a reason for hiding this comment

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

The examples in the current docs report smoothness < 1 with "cor" and > 1 with "diff". Can you add some explanations on how to interpret those?

Copy link
Member Author

Choose a reason for hiding this comment

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

indeed, actually the "diff" method had a reversed interpretation. I fixed accordingly (but that's a breaking change)

Copy link
Member

Choose a reason for hiding this comment

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

Thanks, this requires a bullet point in NEWS and fixing the tests

Copy link
Member

Choose a reason for hiding this comment

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

Thanks, this requires a bullet point in NEWS and fixing the tests

image

@etiennebacher etiennebacher changed the title [docs] document smoothness #374 Improve documentation of smoothness() Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@strengejacke strengejacke strengejacke left review comments

@etiennebacher etiennebacher etiennebacher left review comments

@mattansb mattansb Awaiting requested review from mattansb

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Doc of smoothness() looks quite empty
3 participants
@DominiqueMakowski @strengejacke @etiennebacher