Package: fireSenseUtils 0.2.3.9181

Eliot J B McIntire

fireSenseUtils: Utilities for Working With the 'fireSense' Group of 'SpaDES' Modules

Utilities for working with the 'fireSense' group of 'SpaDES' modules.

Authors:Jean Marchal [aut], Eliot J B McIntire [aut, cre], Alex M Chubaty [aut], Ian Eddy [aut]

fireSenseUtils_0.2.3.9181.tar.gz
fireSenseUtils_0.2.3.9060.zip(r-4.7-any)fireSenseUtils_0.2.3.9060.zip(r-4.6-any)fireSenseUtils_0.2.3.9060.zip(r-4.5-any)
fireSenseUtils_0.2.3.9060.tgz(r-4.6-any)fireSenseUtils_0.2.3.9118.tgz(r-4.5-any)
fireSenseUtils_0.2.3.9060.tar.gz(r-4.7-any)fireSenseUtils_0.2.3.9181.tar.gz(r-4.6-any)
fireSenseUtils_0.2.3.9181.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
fireSenseUtils/json (API)

# Install 'fireSenseUtils' in R:
install.packages('fireSenseUtils', repos = c('https://predictiveecology.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/predictiveecology/firesenseutils/issues

On CRAN:

Conda:

5.08 score 1 stars 298 exports 128 dependencies

Last updated from:e2353d5e1e (on development). Checks:7 FAIL, 2 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develFAIL179
source / vignettesOK519
linux-releaseFAIL138
macos-releaseFAIL117
macos-oldrelFAIL100
windows-develFAIL84
windows-releaseFAIL64
windows-oldrelFAIL75
wasm-releaseOK172

Exports:.doDataChecks.objfunSpreadFitaddBufferEdgeaddFitClimateVariablesaddFitClimateVariablesForFireadWeightAutoannualStackToDTx1000assertCovariateRangeassessFuelClassesbestByReplicatedMeanbufferEdgebufferOpenbufferToAreabufferToAreaRastburnableHaTxtcalcNonForestYoungAgecalcYoungAgecalibratePowerLawcanClimateProjectedYearscastCohortDatacheckEscapeDefinitioncheckLinkParamschk_duplicatedStartPixelschooseDomSecFuelClassescleanUpSpreadFirePointsclearYoungAgeclimateCovRangesclimateNAnamesclimateRasterToDataTablecoefIdentifiabilitycohortsToFuelClassescombinePlanscombineSpreadProbSummariescoreFractionTxtcovsX1000AndSetDFcrpsWeightsDefaultdataYearBeforedataYearElementdataYearFordefaultClimateVariablesForFiredefaultDataYearsdefaultFireYearsdeoptimPopulationSizedropRepeatedFirePointsdtReplaceNAwith0ELFfireCountsELFfireOverlayELFfireRatesELFfitStatusELFflammableAreaelfLabelsELFmergedNameELFmergePlanELFmetricsFilenameELFneighboursELFregionStatsELFrunNameELFsArcticELFsExcludedELFsInStudyAreaELFsizePlanELFsNotFittedELFsSkippedELFtemplateRasteremptySpreadCovariatesescapeDefinitionescapeDefinitionOfescapedFiresescapedIgnitionsescapeFireSetescapeFireSetDepsescapeIgnitionPointsescapeProbPerIgnitionescapeSizePixelsescapesTxtfewFireELFsfireCauseCodesfireClimateLayersfirePixelsByYearfireRecordShapefilefireSenseCloudParametersfireSenseCloudParametersMapfireSenseCovariatesCreatefireSenseELFCoreValuefireSenseEscapeSizeHafireSenseFireCausesfireSenseFlammabilityThresholdfireSenseForestedLCCfireSenseFuelClassColfireSenseIgAggFactorfireSenseNonflammableLCCfireSenseNonForestCanBeYoungAgefireSensePhasesfireSenseRunawayEdgeFracfireSenseRunawayEdgeMinfireSenseSCANFIVersionfireSenseYoungAgeCutofffireSpreadSDTxtfireStartsfitConvergencefitDataNeededfixedLogisticParsfoldMeanPredictionfoldModelsforeignObjectivesfuelClassPrepfuelCovsStaticfuelCovsStaticIsForfuelCovsToCoarsefuelLinearRangefuelLogToLineargetFirePoints_NFDBgetFirePoints_NFDB_V2getFirePolygonsharmonizeBufferAndPointsharmonizeFireDataharmonizeFireDataDepshindcastObservedhindcastSetuphindcastSimulatedidentifiedInIsolationignitionFitAdditionalColNamesTxtignitionFitFilenameForignitionFitFileTagignitionFitLedgerFolderignitionObjectiveTxtignitionPolygonPairsignitionsTxtigOrEscNamesinELFCoreisLinearFuelRangeisYoungAgelatestIgnitionFitslatestNBACUrllatestSpreadFitslccFlammableShareledgerFileOrderlinearLinkParslinearLinkProblinkSaturationlogistic2plogistic3plogistic3pUpperlogistic4plogistic5plogisticAlllogisticParamNameslogMinBmakeELFsmakeFireIDsmakeFireSenseLCCmakeFireSenseLCCDepsmakeLandcoverDTmakeLociListmakeMutuallyExclusivemakeTSDmergeELFsmergePreparedCovsmultipliermustFitmutuallyExclusiveRowsnfdbFirePointsnfdbFirePointsOfCausesnfdbPointUrlnonEscapedFireSizesnonNFColNamesTxtnThreadsomitNullArgsparamsSeparatephaseEventsplotBurnSummaryplotCumulativeBurnsplotELFsplotHindcastDistributionsplotHindcastMapplotHindcastSizesplotHistoricFiresplotSpreadFitResponseplotSpreadFitValidationpointsOfCausespolyCauseColTxtpolygonIDTxtpolygonIgnitionspolySizeColTxtpowerLawLinkpowerLawOmitArgspowerLawPcBoundspowerLawSmoothLinkpredictIgnitionprepare_FuelCovsCoarseprepare_FuelCovsCoarseByYearprepare_ignitionClimateprepare_LightningDataprepareCovariatesOuterprofileCoefficientsputBackIntoRasterrasterFireBufferDTrasterFireSpreadPointsrbetaBetweenreadELFmetricsreadLightningDatareadSpreadFitLedgerreadYearEffectsremoveBufferedFiresOutsideRTMrescaleCovariatesrescaleKnown2rescaleVarsByMagnituderescorePopulationresolveDoFitrichardsLinkrunDEoptimrunELFsrunJobscanfiV2YearsscoreFireSizesscoreFireSizesByYearscorePopulationTermssetXgbThreadssimulateFireSizessizeRuleLandCoverspreadAddInteractionsspreadAsymptoteLinksspreadClimateColsspreadClimateRefspreadCovCentrespreadCovColsspreadDesignColsspreadFitAdditionalColNamesspreadFitAdditionalColNamesTxtspreadFitClimateRefTxtspreadFitClimateVariablesspreadFitCovCentreTxtspreadFitFilenameForspreadFitFileTagspreadFitFuelScaleTxtspreadFitInSampleSizesTxtspreadFitLedgerFolderspreadFitLedgerInputListsspreadFitLedgerInputsspreadFitLowerAsymptoteTxtspreadFitPowerLawGammaTxtspreadFitPowerLawPc50TxtspreadFitPowerLawPcMarginTxtspreadFitPowerLawR2TxtspreadFitPowerLawShapeTxtspreadFitRichardsNuTxtspreadFitValidationDataspreadFitWorkerMemoryGBspreadFuelColsspreadFuelScalespreadHasCovariatesspreadIndicatorColsspreadIndicatorRangesspreadInteractionColsspreadInterceptTxtspreadLinearLinksspreadLinkInputsspreadLinkOptionsspreadLinkParNamesspreadLinkTxtspreadLowerAsymptoteMinspreadPowerLawGammaspreadPowerLawLinksspreadPowerLawPcBoundsspreadPowerLawPGridspreadPowerLawShapespreadProbCeilingspreadProbFloorspreadProbFromCovsspreadProbFromIntegerCovsspreadProbGatesspreadProbGateTestspreadProbSummaryspreadRandomEffectArgsspreadRandomEffectTxtspreadRichardsBspreadRichardsNuspreadSourceColsstackAndExtractstopIfNonForestCannotBeYoungstoredFitProblemtermsInDEoptimtoX1000treedWetlandAgbTxttreedWetlandTxttsdTableunburnableLinkParsupdateStackYearNamesvisualizeDExgbFeatureNamesxgbObjectiveyearEffectMultiplieryearEffectSDyearSpreadSDTxtyearTxtyoungAgeAtYearyoungAgeExclusiveColsyoungAgeTxt

Dependencies:abindamcaskpassbackportsbase64encbitopsbootcallrcharportcheckmateclassclassIntcliclimateDataclusterscodetoolscowplotcpp11crayoncurldata.tableDBIDEoptimdigestdismodplyre1071EnvStatsfarverfastDummiesfasterizefilelockfireregimetoolsFormulafpComparefsgarglegenericsggplot2ggspatialgluegoogledrivegridExtragtablehmshttrhttr2igraphinsightisobandjpegjsonliteKernSmoothlabelingLandRlatticelifecyclelme4lobstrmagrittrMASSMatrixmimeminqaMuMInnlmenloptrnortestopensslotelpakparallellypatchworkpemiscpeutilspillarpkgconfigpngprettyunitsprocessxprogressproxypspurrrqs2quickPlotR6rappdirsrasterrbibutilsRColorBrewerRcppRcppArmadilloRcppEigenRcppParallelRCurlRdpackreformulasreproducibleRequireRhpcBLASctlrlangrosmrstudioapis2S7scalessfspSpaDES.coreSpaDES.toolsstringistringrsysterratibbletidyrtidyselecttidyterraunitsutf8uuidvctrsviridisviridisLitewhiskerwithrwk

fireSense tutorial
Introduction | Fit the statistical model of fire ignitions | Fit the statistical model of fire escapes | Fit the statistical model of the spread probabilities | Fit the statistical model of the fire size distribution | Produce the maps of the tapered Pareto parameters | Use predicted parameters of the tapered Pareto as inputs to the statistical model of the spread probabilities | Predict maps of fire ignition rates, escape and spread probabilities | Fire ignition rates | Fire escape probabilities | Fire spread probabilities | Run fireSense, finally! | Additional resources | References

Last update: 2026-10-18
Started: 2020-04-03

fireSense LCC flammability analysis
Compare LCC and fire data | Plot

Last update: 2026-09-01
Started: 2020-11-24

Readme and manuals

Help Manual

Help pageTopics
'fireSenseUtils' packagefireSenseUtils-package fireSenseUtils
Objective function for 'fireSense_spreadFit' module.objfunSpreadFit
Abbreviate species names for fuel classesabbreviateSpNames
Add the climate variables of existing fits to what is being preparedaddFitClimateVariables
The fire models' climate variables with those of stored fitsaddFitClimateVariablesForFire
Automatic weight for the Anderson-Darling termadWeightAuto
Convert list of annual 'SpatRaster' to 'data.table'annualStackToDTx1000 annualStackToDTx1000.list annualStackToDTx1000.Raster annualStackToDTx1000.SpatRaster
Assert that rescaled spread covariates are usableassertCovariateRange
Semi-automated selection of fuel classed based on GLMsassessFuelClasses
The edge ring of each fire's buffer, and its open partaddBufferEdge bufferEdge bufferOpen
Create buffers around polygons based on area target for bufferbufferToArea bufferToArea.list bufferToArea.sf bufferToArea.SpatialPolygons
Create a variable sized buffer around a set of pixels belonging to the same fire IDbufferToAreaRast
Modify 'cohortData' with burn columnbuildCohortBurnHistory
Zero-out young non-forest pixels across LCC layers and add a 'youngAge' maskcalcNonForestYoungAge
Iteratively calculate 'youngAge' column in FS covariatescalcYoungAge
Calibrate the '"powerLaw"' link's 'gamma' on a flammable mapcalibratePowerLaw
The years of projected climate that canClimateData preparescanClimateProjectedYears
preparing covariates for fitting modulescastCohortData
Stop if a stored escape definition differs from the current onecheckEscapeDefinition
Check the parameters of the links with a lower asymptotecheckLinkParams
Data checks and assertions for 'spreadFitRun'.doDataChecks chk_duplicatedStartPixels
Choose an ELF's dominant and secondary fuel classeschooseDomSecFuelClasses
Ensure fire points are located on flammable pixels inside a fire polygon Intended to be run using 'Map'cleanUpSpreadFirePoints
Clear fuel, non-forest land cover and treed wetland where 'youngAge' is 1clearYoungAge
Fixed ranges of the spread covariatesclimateCovRanges
ClimateNA names of climate variables given with or without underscoresclimateNAnames
Converts stacks of climate rasters to data.table and optionally subsets to indexclimateRasterToDataTable
Classify 'pixelGroups' by flammabilitycohortsToFuelClasses
Merging and assignment of fuel classescombine_fuel_classes
Add the size merges to the fire-count plancombinePlans
Convert covariates to/from integers for smaller footprint; make 'data.frame'covsX1000AndSetDF
Weights of the CRPS spread objectivecrpsWeightsDefault
The data year a year's vegetation comes fromdataYearBefore dataYearElement dataYearFor
Default climate variables for the fire modelsdefaultClimateVariablesForFire
Default vegetation data years for the fireSense modulesdefaultDataYears
Default fire years for the fireSense modulesdefaultFireYears
Default DEoptim population size for a fitdeoptimPopulationSize
NFDB fire points with one row per firedropRepeatedFirePoints
Replace 'NA's in a 'data.table' with zerosdtReplaceNAwith0
Count fires in each ELFELFfireCounts
Clip fire polygons to each ELF, onceELFfireOverlay
Fires per year in each ELF's coreELFfireRates
Classify each ELF as zero, few or ok on its fire countsELFfitStatus
Measure flammable area in each ELFELFflammableArea
Text to print on ELFselfLabels
Name of a merged ELFELFmergedName
Decide which ELFs with too few fires to merge, and which not to fitELFmergePlan
Per-run ELF metrics, for the national mapELFmetricsFilename readELFmetrics
Shared core borders between ELFsELFneighbours
Area, land cover and burn rate of each regionELFregionStats
The ELF to run for an ELF idELFrunName
ELFs that cannot be fittedELFsExcluded
Identify and rasterize Ecologically-based Low Fractal-dimensional objects within a study areaELFsInStudyArea
Merge regions that are too small with a similar neighbourELFsizePlan
ELFs permanently left out of fireSenseELFsArctic ELFsNotFitted
ELFs not fitted after mergingELFsSkipped
Build a Canada-wide raster template for ELF constructionELFtemplateRaster
Spread covariates that carry no informationemptySpreadCovariates
The definition of an escaped fireescapeDefinition
The escape definition of a SpaDES runescapeDefinitionOf
Fires that escapedescapedFires
Ignitions that escaped: those that became a burned-area polygon of at least 'escapeSizeHa'escapedIgnitions
Functions whose code affects what 'escapeFireSet()' and 'escapeIgnitionPoints()' returnescapeFireSetDeps
The ignitions the ignition and escape models are fitted to, and the hindcast countsescapeIgnitionPoints
The chance that one ignition escapes, from the expected escapes of an ignited pixelescapeProbPerIgnition
Pixels a fire must burn to count as escapedescapeSizePixels
Count fires per ELF and merge ELFs with too fewfewFireELFs
Cause groups and the NFDB / NBAC values in themfireCauseCodes
Climate layers needed by the fire modelsfireClimateLayers
Pixel IDs burned in each yearfirePixelsByYear
Path to the shapefile in a fire-record archivefireRecordShapefile
Get current state of FireSense Fit parameters as a mapfireSenseCloudParameters
Get current state of FireSense Fit parameters as a mapfireSenseCloudParametersMap
Create FireSense Input CovariatesfireSenseCovariatesCreate
Non-flammable land-cover codes for the FireSense land coverfireSenseNonflammableLCC
The phases a fireSense job can be split intofireSensePhases
Defaults shared by the fireSense modules and functionsfireSenseELFCoreValue fireSenseEscapeSizeHa fireSenseFireCauses fireSenseFlammabilityThreshold fireSenseForestedLCC fireSenseFuelClassCol fireSenseIgAggFactor fireSenseNonForestCanBeYoungAge fireSenseRunawayEdgeFrac fireSenseRunawayEdgeMin fireSenseSCANFIVersion fireSenseSharedDefaults fireSenseYoungAgeCutoff
Hard-coded name/text constantsburnableHaTxt coreFractionTxt escapesTxt fireSenseUtils-constants fireSpreadSDTxt ignitionFitAdditionalColNamesTxt ignitionObjectiveTxt ignitionsTxt nonNFColNamesTxt polyCauseColTxt polygonIDTxt polySizeColTxt spreadAsymptoteLinks spreadFitAdditionalColNamesTxt spreadFitClimateRefTxt spreadFitCovCentreTxt spreadFitInSampleSizesTxt spreadFitLowerAsymptoteTxt spreadFitPowerLawGammaTxt spreadFitPowerLawPc50Txt spreadFitPowerLawPcMarginTxt spreadFitPowerLawR2Txt spreadFitPowerLawShapeTxt spreadFitRichardsNuTxt spreadInterceptTxt spreadLinearLinks spreadLinkOptions spreadLinkParNames spreadLinkTxt spreadLowerAsymptoteMin spreadPowerLawGamma spreadPowerLawLinks spreadPowerLawPGrid spreadPowerLawShape spreadRandomEffectTxt spreadRichardsB spreadRichardsNu treedWetlandAgbTxt treedWetlandTxt yearSpreadSDTxt yearTxt youngAgeTxt
One start per fire polygon, and whether it is in the coreescapeFireSet fireStarts
Will this job read the data prepared for a fit?fitDataNeeded
Diagnostics of a fitted spread modelcoefIdentifiability combineSpreadProbSummaries fitConvergence fitDiagnostics identifiedInIsolation linkSaturation profileCoefficients scoreFireSizes scoreFireSizesByYear simulateFireSizes spreadProbSummary
The Google Drive folder of the shared fit ledgersfitLedgerFolders ignitionFitLedgerFolder spreadFitLedgerFolder
The logistic parameters fixed at 1, not fittedfixedLogisticPars
The fold models of an ignition or escape fit, and their mean predictionfoldMeanPrediction foldModels
Calculate proportional burn of landcover and tree speciesfuelClassPrep
The part of 'fuelCovsToCoarse()' that does not depend on the covariate valuesfuelCovsStatic
Was a 'static' made for these inputs?fuelCovsStaticIsFor
Range that puts linear fuel biomass on the scale the spread fit usesfuelLinearRange
Fuel biomass from the log scale back to the linear scalefuelLogToLinear
Get Fire 'SpatialPoints' from Canadian Fire DatabasegetFirePoints_NFDB
Get Fire 'SpatialPoints' from Canadian Fire DatabasegetFirePoints_NFDB_V2
Download and prepare fire data from National Fire DatabasegetFirePolygons
Cleaning up the polygon pointsharmonizeBufferAndPoints
Harmonize fire dataharmonizeFireData
Functions whose code affects what 'harmonizeFireData()' returnsharmonizeFireDataDeps
Observed fire in an ELF core in one yearhindcastObserved
What a fireSense hindcast job changes in a 'setupProject()' callhindcastSetup
One simulated year in an ELF corehindcastSimulated
The shared IgnitionFit ledger filesignitionFitFilenameFor ignitionFitFileTag latestIgnitionFits
Ignition points and the fire polygons they matchignitionPolygonPairs
Construct standardized FireSense object namesigOrEscNames
Which points or cells are in an ELF's coreinELFCore
Was this covariate rescaled as linear fuel biomass?isLinearFuelRange
Is an age young?isYoungAge
Discover the URL of the most recent NBAC shapefile archivelatestNBACUrl
Each land-cover class's share of an ELF's flammable pixelslccFlammableShare
The order to read ledger files in: newest first, by the date in the suffixledgerFileOrder
The parameters of a linear-predictor link, in the order of 'spreadCpp(linkPars =)'linearLinkPars
Spread probability from the linear predictor, for a link of spreadLinearLinkslinearLinkProb
Multiple-parameter versions of logistic functionslogistic2p logistic3p logistic3pUpper logistic4p logistic5p logisticAll
Logistic parameter nameslogisticParamNames
Log with a minimumlogMinB
Make Ecologically-based Low Fractal-Dimensional polygonsmakeELFs plotELFs
Identify each year's individual fires and buffer them accordinglymakeFireIDs
Prepare NTEMS Land Cover Data for Fire Simulation ModelsmakeFireSenseLCC
Functions whose code affects what 'makeFireSenseLCC()' returnsmakeFireSenseLCCDeps
Wrapper on 'glm' that creates separate GLMs for each item in fuelmakeGLM
Create 'landcoverDT' object to classify and track non-forest land cover classesmakeLandcoverDT
Convert a list of 'SpatialPointsDataFrame' object to a list of 'data.table' objectsmakeLociList
guarantees mutually exclusive values in a data tablemakeMutuallyExclusive
Put 'cohortData' back into a 'SpatRaster' with some extra detailsmakeRastersFromCD
Prepare a time since disturbance map from stand age and fire datamakeTSD
Merge ELF maps as plannedmergeELFs
Build ignition covariates table by stacking/extracting rasters and joining lightningmergePreparedCovs
Buffer-size multiplier for fire footprintsmultiplier
Must this run fit, given 'doFit' and the ledger?mustFit
Rows where an interaction is cleared by mutual exclusivitymutuallyExclusiveRows
NFDB fire points in a study area, of every size and causenfdbFirePoints
The study area's NFDB fire points of the given causes, one row per firenfdbFirePointsOfCauses
URL of the National Fire Database point archivenfdbPointUrl
Sizes of the fires that did not escapenonEscapedFireSizes
Threads for training multi-threaded librariesnThreads
Names of the arguments that are 'NULL', to give to 'Cache(omitArgs =)'omitNullArgs
Split the character vector of parameters into 'covPars' and 'logisticPars'paramsSeparate
The 'SpaDES.core' event barriers of a phasephaseEvents
Plot burn summaryplotBurnSummary
Plot cumulative burn mapsplotCumulativeBurns
Simulated rep-years beside the observed yearplotHindcastDistributions
Burn-frequency map with the observed fires on topplotHindcastMap
Fire-size distribution, simulated and observedplotHindcastSizes
Plot historic ignitions, escapes, and area burnedplotHistoricFires
NFDB fire points of the given cause groupspointsOfCauses
Ignitions for natural-cause fire polygons that no ignition point matchespolygonIgnitions
The power-law spread linkpowerLawLink
Which arguments a 'link''s cache key leaves outpowerLawOmitArgs
Per-ELF bounds of 'p_c' for the '"powerLaw"' linkpowerLawPcBounds
The power-law spread link with a lower asymptotepowerLawSmoothLink
Predictions from ignition modelpredictIgnition
Create and aggregate fuel covariate rasters to a coarse resolutionprepare_FuelCovsCoarse
Fuel covariate rasters at a coarse resolution, with 'youngAge' resolved for each fire yearprepare_FuelCovsCoarseByYear
Aggregate and cache ignition-related climate rastersprepare_ignitionClimate
Prepare and cache lightning rasters from Google Drive sourcesprepare_LightningData
Prepare and (optionally) cache scaled covariates for modelingprepareCovariatesOuter
Rebuild land cover layers back into a SpatRastserputBackIntoRaster
this is a wrapper to simplify caching of 'lapply' with 'bufferForFireRaster'. Years are iteratively processed by 'makeFireID'.rasterFireBufferDT
Create a list of annual ignition points based on fire rasterrasterFireSpreadPoints
Generate random beta variates between 2 values and a meanrbetaBetween
Read lightning datareadLightningData
Read the SpreadFit ledger rows for a study areareadSpreadFitLedger
Read the fitted year effects of national ignition ledgersreadYearEffects
Remove buffered fires in 'fireBufferedListDT' that are outside 'flammableRTM'removeBufferedFiresOutsideRTM
Rescale/standardize covariates for modelingrescaleCovariates
rescale function no.2rescaleKnown2
Rescale a 'data.table' according to a named vector of rescalersrescaleVarsByMagnitude
Re-score a population with replication, and pick the best members by their meanbestByReplicatedMean rescorePopulation
Resolve the 'doFit' parameter of the FireSense fit modulesresolveDoFit
The Richards (generalized logistic) spread linkrichardsLink
Run 'DEoptim'runDEoptim termsInDEoptim
Run the ELFs module and return the ELF names or mapsrunELFs
Run one fireSense job of an ELFrunJob
SCANFI V2 vegetation yearsscanfiV2Years
Every member's objective terms, on common random numbersscorePopulationTerms
Set the number of threads 'xgboost' uses in this sessionsetXgbThreads
Path to the land-cover map the size rule usessizeRuleLandCover
The climate covariates of a spread formulaspreadClimateCols
The climate reference of a spread fit with climate outside the ceilingspreadClimateRef
The centre of each covariate of a spread fit: its mean over the data the objective usesspreadCovCentre
The columns of the spread model's design, in the order of its coefficientsspreadAddInteractions spreadCovCols spreadDesignCols spreadInteractionCols spreadSourceCols
Default values for various thingsspreadFitAdditionalColNames
The climate variables of stored spread fitsspreadFitClimateVariables
The shared SpreadFit ledger fileslatestSpreadFits spreadFitFilenameFor spreadFitFileTag spreadFitFuelScaleTxt spreadFuelScale
Per-ELF species, fuel and climate inputs from SpreadFit ledger rowsspreadFitLedgerInputLists spreadFitLedgerInputs
Compare a spread fit with the data it was fitted toplotSpreadFitResponse plotSpreadFitValidation spreadFitValidationData
Memory (GB) assumed per DEoptim worker before a fit has a memory recordspreadFitWorkerMemoryGB
Does the spread model have a covariate?spreadHasCovariates
Indicator covariates of the spread modelspreadFuelCols spreadIndicatorCols spreadIndicatorRanges
The linear predictor and the link parameters of a spread link of spreadLinearLinksspreadLinkInputs
The spread-probability ceiling and floorspreadPowerLawPcBounds spreadProbBounds spreadProbCeiling spreadProbFloor
The spread probability of each pixel from its covariates: the one place the spread link is computedspreadProbFromCovs
Convert covariates from their 'x1000' integer to usable by spreadspreadProbFromIntegerCovs
Would parameter sets pass the objective's spreadProb gates in its first block of years?spreadProbGates
The objective's spread-probability gates, on one year's spreadProbspreadProbGateTest
The random-effect arguments of the spread objective, from a fit's boundsspreadRandomEffectArgs
Prepare covariate table with ignition year, fuel class, climate value, and land coverstackAndExtract
Stop unless non-forest can be 'youngAge'stopIfNonForestCannotBeYoung
Convert numeric values to integers x 1000toX1000
Time since disturbance of every pixel, as the table 'youngAgeAtYear()' readstsdTable
Link parameters of cells that cannot burnunburnableLinkPars
Update name of layers in a climate raster stackupdateStackYearNames
Make histograms of 'DEoptim' object 'pars'visualizeDE
The features of an ignition or escape fit, and whether a stored fit can predictforeignObjectives storedFitProblem xgbFeatureNames
The objective an xgboost model was fitted withxgbObjective
The year effect on an expected count: a mean-one lognormal multiplieryearEffectMultiplier yearEffectSD
'youngAge' of pixels at one fire yearyoungAgeAtYear
Columns 'youngAge' is mutually exclusive withyoungAgeExclusiveCols