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

Clarify chain_ll() documentation #75

Merged
merged 3 commits into from
Jun 21, 2023
Merged

Conversation

jamesmbaazam
Copy link
Collaborator

This PR seeks to clarify the documentation of chain_ll() so that it states that the function is used to estimate log-likelihoods, not likelihoods. All occurrences of "likelihood" have been replaced with "log-likelihood" in the documentation.

This PR closes #73.

@codecov-commenter
Copy link

codecov-commenter commented Jun 20, 2023

Codecov Report

Merging #75 (38628bb) into main (3107fd6) will increase coverage by 0.01%.
The diff coverage is 100.00%.

❗ Current head 38628bb differs from pull request most recent head 3756587. Consider uploading reports for the commit 3756587 to get more accurate results

@@            Coverage Diff             @@
##             main      #75      +/-   ##
==========================================
+ Coverage   96.23%   96.25%   +0.01%     
==========================================
  Files           5        5              
  Lines         239      240       +1     
==========================================
+ Hits          230      231       +1     
  Misses          9        9              
Impacted Files Coverage Δ
R/likelihoods.R 100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Collaborator

@sbfnk sbfnk left a comment

Choose a reason for hiding this comment

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

Looks good to me - thanks!

@joshwlambert
Copy link

All the changes look good.

A note for future PRs, if you feature branch is behind main (as was the case for this PR) it is better to rebase the feature branch onto the head of main. This provides a cleaner commit history by removing the merge commit.

@sbfnk
Copy link
Collaborator

sbfnk commented Jun 21, 2023

A note for future PRs, if you feature branch is behind main (as was the case for this PR) it is better to rebase the feature branch onto the head of main. This provides a cleaner commit history by removing the merge commit.

True although as a counterargument they require a force push (and sometimes resolving conflicts across multiple commits) which can be more involved / harder to track down problems.

@joshwlambert
Copy link

joshwlambert commented Jun 21, 2023

I agree that both methods have their advantages & disadvantages. I'm just parroting the Epiverse protocol explained in blueprints.

@jamesmbaazam jamesmbaazam merged commit dd98396 into main Jun 21, 2023
9 checks passed
@jamesmbaazam jamesmbaazam deleted the clarify_chain_ll_docs branch June 21, 2023 13:02
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.

Make clear whether chain_ll() function calculates a likelihood or loglikelihood
4 participants