scaleSSsToMax: Scale sample sizes, with a maximum allowed value

View source: R/scaleSSsToMax.R

scaleSSsToMaxR Documentation

Scale sample sizes, with a maximum allowed value

Description

Function to scale sample sizes, with a maximum allowed value.

Usage

scaleSSsToMax(dfrSS, colSS = "ss", sclSS = 1, maxSS = 200)

Arguments

dfrSS

- dataframe with sample sizes

colSS

- name of column with sample sizes

sclSS

- sample size to scale by

maxSS

- max output sample size allowed

Details

The sample sizes in column colSS are scaled such that dfrSS[[colSS]] = min(maxSS,maxSS/sclSS * dfrSS[[colSS]])

Value

copy of input dataframe, but with scaled sampled sizes in column colSS


wStockhausen/wtsSizeComps documentation built on March 17, 2024, 3:09 p.m.