33
44# ContourFunctions
55
6+ <!-- badges: start -->
7+
68[ ![ Travis-CI Build
79Status] ( https://travis-ci.org/CollinErickson/ContourFunctions.svg?branch=master )] ( https://travis-ci.org/CollinErickson/ContourFunctions )
8- [ ![ CRAN \_ Status \_ Badge ] ( https://www.r-pkg.org/badges/version/ContourFunctions )] ( https://cran.r-project.org/package=ContourFunctions )
10+ [ ![ CRAN_Status_Badge ] ( https://www.r-pkg.org/badges/version/ContourFunctions )] ( https://cran.r-project.org/package=ContourFunctions )
911[ ![ Codecov test
1012coverage] ( https://codecov.io/gh/CollinErickson/ContourFunctions/branch/master/graph/badge.svg )] ( https://codecov.io/gh/CollinErickson/ContourFunctions?branch=master )
13+ [ ![ R-CMD-check] ( https://github.com/CollinErickson/ContourFunctions/actions/workflows/R-CMD-check.yaml/badge.svg )] ( https://github.com/CollinErickson/ContourFunctions/actions/workflows/R-CMD-check.yaml )
14+ <!-- badges: end -->
1115
1216This is an R package that provides simple functions for creating contour
1317plots.
@@ -16,35 +20,36 @@ plots.
1620
1721The main functions are:
1822
19- - ` cf_grid ` : Makes a contour plot from grid data.
23+ - ` cf_grid ` : Makes a contour plot from grid data.
2024
21- - ` cf_func ` : Makes a contour plot for a function.
25+ - ` cf_func ` : Makes a contour plot for a function.
2226
23- - ` cf_data ` : Makes a contour plot for a data set by fitting a Gaussian
24- process model.
27+ - ` cf_data ` : Makes a contour plot for a data set by fitting a Gaussian
28+ process model.
2529
26- - ` cf ` : Passes arguments to ` cf_function ` or ` cf_data ` depending on
27- whether the first argument is a function or numeric.
30+ - ` cf ` : Passes arguments to ` cf_function ` or ` cf_data ` depending on
31+ whether the first argument is a function or numeric.
2832
2933All of these functions make the plot using base graphics by default. To
3034make plots using ggplot2, add the argument ` gg=TRUE ` , or put g in front
31- of the function name. E.g., ` gcf_data(...) ` is the same as `cf_data(...,
32- gg=TRUE)` , and makes a similar plot to ` cf_data` but using ggplot2.
35+ of the function name. E.g., ` gcf_data(...) ` is the same as
36+ ` cf_data(..., gg=TRUE) ` , and makes a similar plot to ` cf_data ` but using
37+ ggplot2.
3338
3439There are two functions for making plots in higher dimensions:
3540
36- - ` cf_4dim ` : Plots functions with four inputs by making a series of
37- contour plots.
41+ - ` cf_4dim ` : Plots functions with four inputs by making a series of
42+ contour plots.
3843
39- - ` cf_highdim ` : Plots for higher dimensional inputs by making a
40- contour plot for each pair of input dimensions and holding the other
41- inputs constant or averaging over them.
44+ - ` cf_highdim ` : Plots for higher dimensional inputs by making a contour
45+ plot for each pair of input dimensions and holding the other inputs
46+ constant or averaging over them.
4247
4348## Installation
4449
4550 # It can be installed like any other package
4651 install.packages("ContourFunctions")
47-
52+
4853 # Or the the development version from GitHub:
4954 # install.packages("devtools")
5055 devtools::install_github("CollinErickson/contour")
@@ -80,6 +85,7 @@ x <- runif(20)
8085y <- runif(20 )
8186z <- exp(- (x - .5 )^ 2 - 5 * (y - .5 )^ 2 )
8287cf_data(x ,y ,z )
88+ # > Fitting with laGP since n <= 200
8389```
8490
8591![ ] ( tools/README-cf_data-1.png ) <!-- -->
0 commit comments