View source: R/hypervolume_resample.R

hypervolume_resample | R Documentation |

`hypervolume_resample`

generates new hyperolumes based on the method input. Outputs written to file.

- `"bootstrap"`

: Generates n hypervolumes using data bootstrapped from original data

- `"bootstrap seq"`

: Generates n hypervolumes for each sample size in sequence specified by user

- `"weighted bootstrap"`

: Same procedure as bootstrap but with sampling weights applied to data (default weights are normal distributed)

```
hypervolume_resample(name,
hv,
method,
n = 10,
points_per_resample = "sample_size",
seq = 3:nrow(hv@Data),
cores = 1,
verbose = TRUE,
to_file = TRUE,
mu = NULL,
sigma = NULL,
cols_to_weigh = 1:ncol(hv@Data),
weights = NULL)
```

`name` |
File name; The function writes hypervolumes to file in ./Objects/<name> |

`hv` |
A hypervolume object |

`method` |
String input; options are |

`n` |
Number of resamples to take. Used for every method. |

`points_per_resample` |
Number of points in each resample. If the input is "sample_size", then the same number of points as the original sample is used.
Used for |

`seq` |
Sequence of sample sizes. If |

`cores` |
Number of logical cores to use while generating bootstraped hypervolumes. If parallel backend already registered to |

`verbose` |
Logical value; If function is being run sequentially, outputs progress bar in console. |

`to_file` |
Logical value; If TRUE, writes resampled hypervolumes to file, otherwise returns an object from |

`mu` |
Array of values specifying the mean of multivariate normal weights.
Used for |

`sigma` |
Array of values specifying the variance in each dimension. (higher variance corresponds to more even weights)
Used for |

`cols_to_weigh` |
Array of column indices; must be same length as mu and sigma.
Used for |

`weights` |
Custom weight assigned to each row of data when resampling.
Used for |

`hypervolume_resample`

creates a directory called Objects in the current working directory if a directory of that name doesn't already exist. Returns an absolute path to directory with resampled hypervolumes. rds files are stored in different file structures depending on which method is called.

Use `to_hv_list`

to extract every hypervolume object in a directory into a HypervolumeList object.
It is also possible to access the hypervolumes by using readRDS to read the hypervolume objects in one by one.

The resampled hypervolumes are generated using the same parameters used to generate the input hypervolume. The only exception is that the bandwidth is re-estimated if `method = "gaussian"`

or `method = "box"`

. See `copy_param_hypervolume`

for more details.

returns a string containing an absolute path equivalent to ./Objects/<name>

`to_hv_list`

, `hypervolume_overlap_test`

, `hypervolume_funnel`

, `hypervolume_overlap_confidence`

```
## Not run:
library(palmerpenguins)
data(penguins)
bill_data = na.omit(penguins[,3:4])
hv = hypervolume(bill_data)
# Example 1: Get 50 resampled hypervolumes
# Use detectCores to see how many cores are availible in current environment
# Set cores = 1 to run sequentially (default)
path = hypervolume_resample("example_bootstrap",
hv,
method = "bootstrap",
n = 50,
cores = 12)
hvs = to_hv_list(path)
# Example 2: Get resample with applied weights
# Get maximum bill length
max_bill = max(bill_data$bill_length_mm)
# Make data with larger bill length slightly more likley to be resampled
weighted_path = hypervolume_resample("weighted test",
hv,
method = "weighted bootstrap",
n = 50,
cores = 12,
mu = max_bill,
sigma = 90,
cols_to_weigh = "bill_length_mm")
hvs_weighted = to_hv_list(weighted_path)
## End(Not run)
```

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.