https://github.com/mlysy/optimcheck

Graphical and numerical checks for mode-finding routines
https://github.com/mlysy/optimcheck

Last synced: 2 months ago
JSON representation

Graphical and numerical checks for mode-finding routines

• Host: GitHub
• URL: https://github.com/mlysy/optimcheck
• Owner: mlysy
• License: gpl-3.0
• Created: 2018-02-27T02:29:00.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-09-05T19:22:51.000Z (5 months ago)
• Last Synced: 2024-11-10T19:07:02.865Z (2 months ago)
• Language: R
• Homepage: https://mlysy.github.io/optimCheck/
• Size: 827 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# optimCheck: Graphical and Numerical Checks for Mode-Finding Routines

*Martin Lysy*

------------------------------------------------------------------------

### Description

Tools for checking that the output of an optimization algorithm is

indeed at a local mode of the objective function. This is accomplished

graphically by calculating all one-dimensional “projection plots” of the

objective function, i.e., varying each input variable one at a time with

all other elements of the potential solution being fixed. The numerical

values in these plots can be readily extracted for the purpose of

automated and systematic unit-testing of optimization routines.

### Installation

To install the CRAN version (1.0.1):

``` r

install.packages("optimCheck", INSTALL_opts = "--install-tests")

```

To install the latest development version: first install the

[**devtools**](https://CRAN.R-project.org/package=devtools) package,

then:

``` r

devtools::install_github("mlysy/optimCheck", INSTALL_opts = "--install-tests")

```

### Usage

A quick tutorial is provided in the package vignette:

`vignette("optimCheck")`.

### Unit Tests

To verify that the package has been installed correctly, you can run its

unit tests. First install the

[**testthat**](https://CRAN.R-project.org/package=testthat) package,

then:

``` r

testthat::test_package("optimCheck", reporter = "progress")

```