formathistab: Format histogram table

In messamat/globalIRmap: What the Package Does (One Line, Title Case)

Description

Creates a binary frequency histogram table by computing the proportion of records for which a selected column has a given value (in this study, the percentage length of rivers that are deemed intermittent) after binning the table by a continuous variable (e.g. river discharge).

Usage

formathistab(
  in_dt,
  castvar,
  valuevar,
  valuevarsub,
  weightvar = 1,
  binfunc,
  binarg,
  binlabels,
  datname = NULL
)

Arguments

in_dt	data.table to bin.
castvar	(character) olumn that will be used to define bins — the equivalent of binvar in bin_dt.
valuevar	(character) variable to summarize (e.g. intermittency class).
valuevarsub	(character) value of valuevar to summarize (e.g. '1' for intermittent rivers)
weightvar	(character) variable to weigh proportion by. (e.g. river reach length).
binfunc	(character) binning approach. One of 'manual', 'equal_length', 'equal_freq'.
binarg	(numeric) binning argument, depends on binning approach (binfunc).
binlabels	(character vector) formatted labels for bins.
datname	(character) optional, adds a column to output table describing what the data describes (e.g. France)

Value

data.table with five columns:

• bin - bin number

• perc - percentage of records (or of weightvar) that meet valuevar == valuevarsub.

• binsumlength - number of records (if default weightvar) or sum of weightvar by bin (e.g. total river length).

• dat - datname argument

• binformat - label for each bin provided through binlabels argument

See Also

used in compare_fr, compare_us, and compare_au

messamat/globalIRmap documentation built on July 4, 2021, 10:48 a.m.