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

Documentation needed for core PrestoGP functions #19

Closed
ericbair-sciome opened this issue Nov 12, 2023 · 1 comment · Fixed by #51
Closed

Documentation needed for core PrestoGP functions #19

ericbair-sciome opened this issue Nov 12, 2023 · 1 comment · Fixed by #51
Assignees
Labels
documentation Improvements or additions to documentation version 1.0 Features that should be included in the initial PrestoGP release

Comments

@ericbair-sciome
Copy link
Collaborator

The documentation/help files for PrestoGP have not been updated since the beginning of the project. Many of them are outdated or non-existent. I will work on adding documentation for the core PrestoGP multivariate functions.

@ericbair-sciome ericbair-sciome added the documentation Improvements or additions to documentation label Nov 12, 2023
@ericbair-sciome ericbair-sciome self-assigned this Nov 12, 2023
@ericbair-sciome ericbair-sciome added the version 1.0 Features that should be included in the initial PrestoGP release label Nov 12, 2023
sciome-bot pushed a commit that referenced this issue Dec 28, 2023
…ode for R and C++

Merge in STAT/prestogp from master to to-git

Squashed commit of the following:

commit 710520c
Merge: d2a2e3a 11771e4
Author: Shail Choksi <shail.choksi@sciome.com>
Date:   Thu Dec 28 14:09:40 2023 -0500

    Pull request #18: Added missing imports and ran auto-formatter in vscode for R and C++

    Merge in STAT/prestogp from build-workflow to master

    * commit '11771e4ccbd6311aa35334c5ab4b7e4299a8db56':
      Added missing imports
      Ran auto-formatter/linter for R and C++ in vscode. Added some missing imports

commit 11771e4
Author: sciome-bot <software.tools@sciome.com>
Date:   Thu Dec 28 14:07:28 2023 -0500

    Added missing imports

commit 73aed75
Merge: 7c0bbfe d2a2e3a
Author: sciome-bot <software.tools@sciome.com>
Date:   Thu Dec 28 13:58:37 2023 -0500

    Merge branch 'master' of ssh://sciome-bot/stat/prestogp into build-workflow

commit d2a2e3a
Merge: bea8382 85517e7
Author: sciome-bot <software.tools@sciome.com>
Date:   Thu Dec 28 13:57:14 2023 -0500

    Merge branch 'master' of ssh://sciome-bot/stat/prestogp

commit bea8382
Merge: 17f5284 1e4361d
Author: sciome-bot <software.tools@sciome.com>
Date:   Thu Dec 28 13:55:26 2023 -0500

    Merge branch 'main-sciome' of sciome-bot-git:Spatiotemporal-Exposures-and-Toxicology/PrestoGP

commit 7c0bbfe
Author: sciome-bot <software.tools@sciome.com>
Date:   Thu Dec 28 13:52:27 2023 -0500

    Ran auto-formatter/linter for R and C++ in vscode. Added some missing imports

commit 85517e7
Merge: 17f5284 2c9c2ed
Author: Shail Choksi <shail.choksi@sciome.com>
Date:   Thu Dec 28 13:12:00 2023 -0500

    Pull request #16: Add UBSAN/ASAN sanitizers

    Merge in STAT/prestogp from build-workflow to master

    * commit '2c9c2ede3d40e6e5af24b38a6acfc2dfb2994975':
      Add USAN/ASAN pipeline
      Pull request #14: Additional Testing
      Additional Testing
      Add UBSAN/ASAN sanitizers

commit 2c9c2ed
Merge: 6af43f4 56cdbf2
Author: sciome-bot <software.tools@sciome.com>
Date:   Thu Dec 28 13:11:14 2023 -0500

    Merge branch 'to-git' of ssh://sciome-bot/stat/prestogp into build-workflow

commit 6af43f4
Merge: e530819 17f5284
Author: sciome-bot <software.tools@sciome.com>
Date:   Thu Dec 28 13:07:50 2023 -0500

    Merge branch 'master' of ssh://sciome-bot/stat/prestogp into build-workflow

commit e530819
Author: sciome-bot <software.tools@sciome.com>
Date:   Thu Dec 28 13:06:21 2023 -0500

    Add USAN/ASAN pipeline

commit 17f5284
Merge: ea78ffa 895100d
Author: Eric Bair <eric.bair@sciome.com>
Date:   Fri Dec 1 10:49:09 2023 -0500

    Pull request #12: Testing

    Merge in STAT/prestogp from testing to master

    * commit '895100db78d89c5082ddfcf1411dad69bdf1b6c5':
      Fixed another sparseNN bug and updated tests
      Fixed a bug in SparseNN
      Added more likelihood and maxmin ordering tests

commit 895100d
Merge: 7f3ca3c fb060ff
Author: Eric Bair <eric.bair@sciome.com>
Date:   Wed Nov 29 17:02:10 2023 -0500

    Merge branch 'to-git' of http://192.168.167.103:7990/bitbucket/scm/stat/prestogp into testing

    Conflicts:
    	DESCRIPTION
    	man/prestogp_fit-PrestoGPModel-method.Rd
    	tests/testthat/test-Log_Likelihood.R

    Fixed merge conflicts.

commit 7f3ca3c
Author: Eric Bair <eric.bair@sciome.com>
Date:   Wed Nov 29 16:43:40 2023 -0500

    Fixed another sparseNN bug and updated tests

commit 1ca9586
Author: Eric Bair <eric.bair@sciome.com>
Date:   Tue Nov 28 18:40:36 2023 -0500

    Fixed a bug in SparseNN

commit 80a9818
Author: Eric Bair <eric.bair@sciome.com>
Date:   Tue Nov 21 17:49:19 2023 -0500

    Added more likelihood and maxmin ordering tests

commit 4822fbc
Author: sciome-bot <software.tools@sciome.com>
Date:   Mon Nov 20 15:01:37 2023 -0500

    Add UBSAN/ASAN sanitizers

commit ea78ffa
Merge: 286ba5d 53e2b0d
Author: sciome-bot <software.tools@sciome.com>
Date:   Mon Nov 20 12:41:08 2023 -0500

    Merge branch 'main-sciome' of sciome-bot-git:Spatiotemporal-Exposures-and-Toxicology/PrestoGP

commit 286ba5d
Merge: f52ebbb 84fd72f
Author: sciome-bot <software.tools@sciome.com>
Date:   Tue Nov 14 13:11:48 2023 -0500

    Merge branch 'main-sciome' of sciome-bot-git:Spatiotemporal-Exposures-and-Toxicology/PrestoGP

commit f52ebbb
Merge: 4e0e1ec 2dd74a2
Author: Eric Bair <eric.bair@sciome.com>
Date:   Tue Nov 14 13:10:51 2023 -0500

    Pull request #9: Testing

    * commit '2dd74a21380be960918b6067abec8ec163721853':
      Added a simulation file for testing
      Fixed likelihood function and added additional tests
      Fixed likelihood function and added additional test

commit 2dd74a2
Author: Eric Bair <eric.bair@sciome.com>
Date:   Mon Nov 13 19:17:43 2023 -0500

    Added a simulation file for testing

... and 3 more commits
@ericbair-sciome
Copy link
Collaborator Author

There is documentation for all user-facing functions in the latest release. Please let me know if anything is incomplete or unclear (or if you see any typos or broken links).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation version 1.0 Features that should be included in the initial PrestoGP release
Projects
None yet
1 participant