Class CsvDataProvider

Data Provider for importing data from wide- or long-format CSV files.

For wide-format CSVs, metrics should specify Metric.dataReference.column with the name of the column containing the metric's data.

For long-format CSVs, metrics should specify Metric.dataReference.variable. This value should be present in the CSV's variableColumn.

Example wide-format CSV:

|region |date       |var1 |var2 |
|TX     |2022-02-01 |12   |45   |
|CA     |2022-02-01 |31   |66   |

Example long-format CSV:

|region |date       |variable |value |
|TX     |2022-02-01 |var1     |12    |
|TX     |2022-02-01 |var2     |45    |
|CA     |2022-02-01 |var1     |31    |
|CA     |2022-02-01 |var2     |66    |

Hierarchy

SimpleMetricDataProviderBase
- CsvDataProvider

Index

Constructors

constructor

new CsvDataProvider(providerId: string, options: CsvDataProviderOptions): CsvDataProvider
Constructs a new CsvDataProvider instance.
Parameters
- providerId: string
  
  A unique provider id to associate with the provider (e.g. "my-datasource-csv"). This ID can be used from a MetricDataReference in a metric to reference the data from this provider.
- options: CsvDataProviderOptions
  
  Options to configure the provider. The regionColumn must match the region identifier in Act Now Coalition's regions package. (e.g. a nation's identifier in the regions package is the ISO 3 code. So data for a nation must have ISO 3 code as its identifier.)
Returns CsvDataProvider
Overrides SimpleMetricDataProviderBase.constructor
- Defined in src/metrics/data_providers/CsvDataProvider.ts:96

Properties

`Private` dataRowsByRegionId

dataRowsByRegionId: undefined | Promise<{
[regionId: string]: DataRow[];
}>

`Private` `Optional` `Readonly` dateColumn

dateColumn?: string

`Readonly` id

id: string

A unique provider id to associate with the provider (e.g. "mock"). This ID can be used from a MetricDataReference in a metric to reference the data from this provider.

`Private` `Optional` `Readonly` longFormatCsvOptions

longFormatCsvOptions?: LongFormatCsvOptions

`Private` `Readonly` regionColumn

regionColumn: string

`Private` `Readonly` regionDb

regionDb: RegionDB

`Private` `Optional` `Readonly` url

url?: string

Methods

`Private` fetchCsvText

fetchCsvText(): Promise<string>
Fetches CSV data from a URL and returns the text content.

Returns
fetched CSV data.

Returns Promise<string>
- Defined in src/metrics/data_providers/CsvDataProvider.ts:177

fetchData

fetchData(regions: Region[], metrics: Metric[], includeTimeseries: boolean, metricCatalog: MetricCatalog): Promise<MultiRegionMultiMetricDataStore<unknown>>
Fetches all of the data for the specified regions and metrics, optionally including timeseries metric data if available.

Returns
The fetched data for the specified regions and metrics.
Parameters
- regions: Region[]
  
  One or more regions to fetch data for.
- metrics: Metric[]
  
  One or more metrics to fetch data for.
- includeTimeseries: boolean
  
  Whether to fetch timeseries data.
- metricCatalog: MetricCatalog
  
  The metric catalog using this data provider. The data provider can call back into the catalog if it needs to fetch dependent data.
Returns Promise<MultiRegionMultiMetricDataStore<unknown>>
Inherited from SimpleMetricDataProviderBase.fetchData
- Defined in src/metrics/data_providers/SimpleMetricDataProviderBase.ts:40

fetchDataForRegionAndMetric

fetchDataForRegionAndMetric(region: Region, metric: Metric): Promise<MetricData<unknown>>
Method to be overridden by subclasses to fetch the specified MetricData.

Returns
The MetricData for the given metric and region.
Parameters
- region: Region
  
  The region to get data for.
- metric: Metric
  
  The metric to get data for.
Returns Promise<MetricData<unknown>>
Overrides SimpleMetricDataProviderBase.fetchDataForRegionAndMetric
- Defined in src/metrics/data_providers/CsvDataProvider.ts:145

`Private` getDataForCache

getDataForCache(csvText?: string): Promise<{
[regionId: string]: DataRow[];
}>
Parameters
- Optional csvText: string
Returns Promise<{
[regionId: string]: DataRow[];
}>
- Defined in src/metrics/data_providers/CsvDataProvider.ts:114

Class CsvDataProvider

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

providerId: string

options: CsvDataProviderOptions

Returns CsvDataProvider

Properties

Private dataRowsByRegionId

Private Optional Readonly dateColumn

Readonly id

Private Optional Readonly longFormatCsvOptions

Private Readonly regionColumn

Private Readonly regionDb

Private Optional Readonly url

Methods

Private fetchCsvText

Returns

Returns Promise<string>

fetchData

Returns

Parameters

regions: Region[]

metrics: Metric[]

includeTimeseries: boolean

metricCatalog: MetricCatalog

Returns Promise<MultiRegionMultiMetricDataStore<unknown>>

fetchDataForRegionAndMetric

Returns

Parameters

region: Region

metric: Metric

Returns Promise<MetricData<unknown>>

Private getDataForCache

Parameters

Optional csvText: string

Returns Promise<{ [regionId: string]: DataRow[]; }>

Settings

Member Visibility

Theme

`Private` dataRowsByRegionId

`Private` `Optional` `Readonly` dateColumn

`Readonly` id

`Private` `Optional` `Readonly` longFormatCsvOptions

`Private` `Readonly` regionColumn

`Private` `Readonly` regionDb

`Private` `Optional` `Readonly` url

`Private` fetchCsvText

`Private` getDataForCache

`Optional` csvText: string

Returns Promise<{
[regionId: string]: DataRow[];
}>