Helper function to list footprint characteristic names and built-in summary functions.
list_fs(what = "all", how = "all")
| what | Character vector of names of characteristics to look up (e.g.
"area"). Alternatively, list |
|---|---|
| how | Character vector of summary functions to look up (e.g. "mean") or
|
Vector or data.frame with selected footprint metric function
names and/or units.
Provides an easy look-up for the built-in function names, and
basic geometric characteristics used by foot. Supplying a "what"
characteristics finds all built-in functions. Conversely, supplying a "how"
function name returns are characteristics for which that summary is
available. Arguments are optional
and if both are omitted the full set of metrics will be returned.
# get the full list of all available list_fs()#> cols funs #> 1 angle cv #> 2 angle entropy #> 3 angle iqr #> 4 angle max #> 5 angle mean #> 6 angle median #> 7 angle min #> 8 angle sd #> 9 area cv #> 10 area iqr #> 11 area max #> 12 area mean #> 13 area median #> 14 area min #> 15 area sd #> 16 area sum #> 17 compact cv #> 18 compact iqr #> 19 compact max #> 20 compact mean #> 21 compact median #> 22 compact min #> 23 compact sd #> 24 leqwratio cv #> 25 leqwratio iqr #> 26 leqwratio max #> 27 leqwratio mean #> 28 leqwratio median #> 29 leqwratio min #> 30 leqwratio sd #> 31 lwratio cv #> 32 lwratio iqr #> 33 lwratio max #> 34 lwratio mean #> 35 lwratio median #> 36 lwratio min #> 37 lwratio sd #> 38 nndist cv #> 39 nndist iqr #> 40 nndist max #> 41 nndist mean #> 42 nndist median #> 43 nndist min #> 44 nndist nnindex #> 45 nndist sd #> 46 perimeter cv #> 47 perimeter iqr #> 48 perimeter max #> 49 perimeter mean #> 50 perimeter median #> 51 perimeter min #> 52 perimeter sd #> 53 perimeter sum #> 54 settled binary #> 55 settled count #> 56 shape cv #> 57 shape iqr #> 58 shape max #> 59 shape mean #> 60 shape median #> 61 shape min #> 62 shape sd# get all summary functions for "area" list_fs(what="area")#> cols funs #> 1 area cv #> 2 area iqr #> 3 area max #> 4 area mean #> 5 area median #> 6 area min #> 7 area sd #> 8 area sum# get all characteristics relevant for entropy list_fs(how="entropy")#> cols funs #> 1 angle entropy