bLSmodelR-Undocumented: undocumented functions

In ChHaeni/bLSmodelR: bLSmodelR - An atmospheric dispersion model in R

undocumented functions

Description

List of undocumented bLSmodelR functions:

Details

• %w/o%: x without y, analogous to %in%

• addScaleBar: add a scale bar to the current plot

• addWindrose: add a wind rose (arrow showing wind direction) to the current plot

• assignCat: assign coreModel output to an empty, initialized TD catalog

• CalcSteps: Get attribute CalcSteps from bLS output

• Catalogs: Get attribute Catalogs from bLS output

• CatPath: Get attribute CatPath from bLS output

• check.compact: check TD catalog for compact attributes

• cleanTemporary: remove temporary TD catalogs

• compactCatalog: make TD catalog compact for saving (not reversible due to rounding!)

• ConcPalette: Colour palette

• extractResult: extract results from model output

• FluxPalette: Colour palette

• getArea: get area of a polygon

• getCatalogs: get TD catalog pathnames from model output

• initializeCatalog: initialize TD catalog

• join: see join.Sensors and join.Sources

• join.bLSresult: merge bLS results consistently

• join.deposition: merge deposition results consistently

• ModelInput: Get attribute ModelInput from bLS output

• prepareIntervals: link existing and upcoming TD catalogs to intervals and possibly optimize MaxFetch

• plot.InputList: S3method calling siteMap

• plotFootprint: plot C-/u'C'-/w'C'-Footprint

• readCatalog: read TD catalog

• rebuildCatListFile: rebuild file with TD catalog list

• rotate: rotate coordinates around a fix point

• rotateCatalog: rotate Catalog (into WD)

• round125: round digits to nearest predefined numbers

• siteMap: plot site map

• sortData: sort data, partially adopted from setorderv

• tag_inside: tag TDs inside source area

• updatePath: update path to TD catalogs

• uvw0: get initial (t=0) velocities from TD catalog

• writeCatalog: write TD catalog (default: saved as compact TD catalog)

• switchNames: change column names (simple/descriptive) of model output

• setDT: change model output to a data.table, see setDT

• setDF: change model output to a data.frame, see setDF

• add_data

• avgCE_sensors

• avgCE_sensors_se

• avgCE_sources

• avgCE_sources_se

• avgSourcesWeights

• calc_fct

• combineSensors

• combineSources

• convert

• getPathLengths

• inters

• plot.bLSresult

• plotPolys

• pnt.in.poly

• print.InputList

• print.Interval

• splitSource

Note

some of these functions will be documented or dropped in future package versions.

Author(s)

Christoph Haeni

See Also

bLSmodelR-package, runbLS

ChHaeni/bLSmodelR documentation built on Dec. 5, 2024, 8:47 a.m.