Package index • madrat

Core Workflow

Main functions to call other pipeline steps

calcOutput(): calcOutput
downloadSource(): downloadSource
readSource(): readSource
retrieveData(): retrieveData
returnCalcOutput(): Construct a list with the information required for calc-functions to return

Available Functions

Discover available calc, read, and tool functions

getCalculations(): getCalculations
getLocation(): getLocation
getSources(): getSources
installedMadratUniverse(): installedMadratUniverse

Configuration

Configuration management for the madrat framework

getConfig(): getConfig
madratAttach() madratDetach(): madratAttach / madratDetach
setConfig() localConfig(): setConfig

Cache Management

Functions for handling cached data

cacheCleanup(): cacheCleanup
cacheCopy(): cacheCopy

Dependency Graph

Analyze function dependencies in the madrat universe

getDependencies(): getDependencies
getMadratGraph(): getMadratGraph
getMadratInfo(): getMadratInfo
visualizeDependencies(): visualizeDependencies

Mapping

Tools for working with mappings

addMapping(): addMapping
toolConvertMapping(): Tool: ConvertMapping
toolGetMapping(): Tool: GetMapping

Aggregation

Spatial aggregation and disaggregation

pucAggregate(): pucAggregate
toolAggregate(): toolAggregate

Tools: Countries

Country and ISO code handling

getISOlist(): get official ISO list
toolCountry2isocode(): toolCountry2isocode
toolCountryFill(): Tool: CountryFill
toolFillWithRegionAvg(): Tool: FillWithRegionAvg
toolISOhistorical(): Tool: ISOhistorical

Tools: Temporal Processing

Time series manipulation and interpolation

toolFillYears(): toolFillYears
toolTimeAverage(): toolTimeAverage
toolTimeSpline(): Smooth a magclass time series with optional anchor years

Tools: Data Manipulation

General data transformation tools

toolConditionalReplace(): toolConditionalReplace
toolFixWeight(): toolFixWeight
toolNAreplace(): Tool: NA replace
toolOrderCells(): toolOrderCells
toolXlargest(): toolXlargest

Tools: Source Downloading

Helpers for downloading source data

metadataGFZ(): metadataGFZ
toolManualDownload(): Tool: ManualDownload

Tools: Subtype Handling

Tools for handling subtypes in read functions

toolSplitSubtype(): Tool: SplitSubtype
toolSubtypeSelect(): Tool: SubtypeSelect

Madrat Messages

Madrat-specific messaging system stored in cache

getMadratMessage(): getMadratMessage
putMadratMessage(): putMadratMessage
resetMadratMessages(): resetMadratMessages
vcat(): Tool: Verbosity Cat

Metadata Comments

Handling metadata comments on magclass objects

getFromComment(): getFromComment

Source Redirection

Redirect source data to alternative locations

getLinkFunction(): getLinkFunction
redirectSource(): redirectSource

Code Labeling

Region code labeling utilities

regionscode(): Tool: regionscode
toolCodeLabels(): Tool: CodeLabels

Validation

Data validation and comparison tools

compareData(): compareData
compareMadratOutputs(): Compare a madrat function's output with and without your changes
toolCompareStatusLogs(): toolCompareStatusLogs

Analysis

Performance analysis tools

findBottlenecks(): findBottlenecks

Example Functions

Example implementations for reference

fullEXAMPLE(): fullExample
readTau(): Read Tau
convertTau(): Convert Tau
calcTauTotal(): Calculate total tau
redirectTau(): redirectTau

Internal

Internal functions

madrat-package madrat: May All Data be Reproducible And Transparent (madrat) *