ssmc_summary: A function to extract the summary data from 'site.analysis'...

View source: R/extract_sort_results.R

ssmc_summaryR Documentation

A function to extract the summary data from site.analysis or best.locale functions

Description

A function to extract the summary data from site.analysis or best.locale functions

Usage

ssmc_summary(ssmc_results, ...)

Arguments

ssmc_results

Output object from site.analysis or best.locale

...

Optional to select which column to sort by when summarizing the results data frame. The default is to sort by rank

Value

This function returns a data frame of the summarized results from either the site.analysis or best.locale sorted by the specified column.

Author(s)

Bill Peterman <Peterman.73@osu.edu>

Examples

   # Assess potential new locations
   best_results <- best.locale(sites = site.dat[,1:3],
   potential.sites = potential.dat,
   pop.abun = site.dat[,4:5],
   met.size = site.dat[,6:7],
   prop.philo = 0.95,
   sd.philo = 0.05,
   min.max_philo=c(min=0, max=1),
   # prop.survive=0.2,      ## Not needed b/c met.size is specified
   # sd.survive = 0.075,    ## Not needed b/c met.size is specified
   min.max_survive = c(min=0, max=1),
   dispersal = 25,
   sd.dispersal = 10,
   min.max_dispersal = c(min=10, max=Inf),
   iterations = 10,
   seed = 123)

## Default
   best_locales <- ssmc_summary(best_results)

## Sort by the adjusted rank
   best_locales <- ssmc_summary(best_results, 'rank_adj')

wpeterman/ssmc documentation built on Sept. 22, 2022, 8:37 a.m.