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

Major cleanup and standardization of naming conventions. #9

Merged
merged 22 commits into from
Jul 17, 2020
Merged

Major cleanup and standardization of naming conventions. #9

merged 22 commits into from
Jul 17, 2020

Conversation

adknudson
Copy link
Member

Functions that are more secondary to the package are now prefixed with some kind of identifier. E.g. any function dealing with correlations is prefixed cor_ while functions that are purely implemented in jax are prefixed jax_.

The main function rvec is currently stripped down to a minimal (single core) version. The intention is to build it back up with the idea in mind that it will be able to handle any list of marginals, and any input type of correlation matrix.

Unit testing is now a thing. All code, whether exported or not, should be documented and have it's own unit test (via testthat). Trivial functions are not as important to test if it is really obvious that they should work. More complex functions definitely need to be tested, and there should be comments about the assumptions of what can go into a function, and what should come out. E.g. something that produces or works on a correlation matrix should produce a matrix that is symmetric with ones on the diagonal (as a start).

This is a pull request to the develop branch as we will likely need to make some small changes to the .travis.yml file and set up this repo for Travis-CI. This will be the last stop before merging into the master branch and setting a new release.

@adknudson adknudson merged commit da24976 into SchisslerGroup:develop Jul 17, 2020
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.

1 participant