docs: improve README examples for stats/base/dists/t namespace
#1728
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stdlib-bot
reviewed
Mar 6, 2024
kgryte
reviewed
Mar 6, 2024
Comment on lines
114
to
115
| console.log( objectKeys( t ) ); | ||
|
|
There was a problem hiding this comment.
Suggested change
| console.log( objectKeys( t ) ); |
There was a problem hiding this comment.
You should remove the utils/keys import.
kgryte
reviewed
Mar 6, 2024
Comment on lines
24
to
25
| console.log( objectKeys( t ) ); | ||
|
|
There was a problem hiding this comment.
Suggested change
| console.log( objectKeys( t ) ); |
kgryte
reviewed
Mar 6, 2024
Comment on lines
117
to
131
| var degreesOfFreedom = 3; | ||
| var xValue = 1.5; | ||
|
|
||
| // Evaluate the probability density function (PDF) at a specific value | ||
| var pdfResult = t.pdf( xValue, degreesOfFreedom ); | ||
| console.log( 'PDF at x = ' + xValue + ': ' + pdfResult ); | ||
|
|
||
| // Evaluate the cumulative distribution function (CDF) at a specific value | ||
| var cdfResult = t.cdf( xValue, degreesOfFreedom ); | ||
| console.log( 'CDF at x = ' + xValue + ': ' + cdfResult ); | ||
|
|
||
| // Get the mean and variance of the t distribution | ||
| var meanValue = t.mean( degreesOfFreedom ); | ||
| var varianceValue = t.variance( degreesOfFreedom ); | ||
| console.log( 'Mean: ' + meanValue + ', Variance: ' + varianceValue ); |
There was a problem hiding this comment.
Suggested change
| var degreesOfFreedom = 3; | |
| var xValue = 1.5; | |
| // Evaluate the probability density function (PDF) at a specific value | |
| var pdfResult = t.pdf( xValue, degreesOfFreedom ); | |
| console.log( 'PDF at x = ' + xValue + ': ' + pdfResult ); | |
| // Evaluate the cumulative distribution function (CDF) at a specific value | |
| var cdfResult = t.cdf( xValue, degreesOfFreedom ); | |
| console.log( 'CDF at x = ' + xValue + ': ' + cdfResult ); | |
| // Get the mean and variance of the t distribution | |
| var meanValue = t.mean( degreesOfFreedom ); | |
| var varianceValue = t.variance( degreesOfFreedom ); | |
| console.log( 'Mean: ' + meanValue + ', Variance: ' + varianceValue ); | |
| var dof = 3; | |
| var x = 1.5; | |
| // Evaluate the probability density function (PDF) at a specific value: | |
| var res = t.pdf( x, dof ); | |
| console.log( 'PDF at x = ' + x + ': ' + res ); | |
| // Evaluate the cumulative distribution function (CDF) at a specific value: | |
| res = t.cdf( x, dof ); | |
| console.log( 'CDF at x = ' + x + ': ' + res ); | |
| // Get the mean and variance of the t distribution: | |
| var mu = t.mean( dof ); | |
| var v = t.variance( dof ); | |
| console.log( 'Mean: ' + mu + ', Variance: ' + v ); |
Follow project conventions in preferring shorter variable names.
kgryte
changed the title
stats/base/dists/t namespacestats/base/dists/t namespace
|
@kgryte Thank you for your feedback! I have addressed all the issues you mentioned in your review. Please take a look at the changes, and let me know if everything looks good now. If you have any further suggestions or concerns, feel free to share them. Thanks again! |
Planeshifter
approved these changes
Mar 6, 2024
bad-in-coding
pushed a commit
to bad-in-coding/stdlib
that referenced
this pull request
Mar 7, 2024
PR-URL: stdlib-js#1728 Closes: stdlib-js#1645 Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
nishant-s7
pushed a commit
to nishant-s7/stdlib
that referenced
this pull request
Mar 7, 2024
PR-URL: stdlib-js#1728 Closes: stdlib-js#1645 Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1645
Description
This pull request:
Improve README examples of
stats/base/dists/tnamespaceRelated Issues
This pull request:
stats/base/dists/tnamespace #1645Questions
No.
Other
No.
Checklist
@stdlib-js/reviewers