stdlib-js / stdlib-js/stdlib

[RFC]: Time Series Generation Module

Ouverte
#2,092 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
difficulty: 2 Feature JavaScript Needs Discussion RFC Utilities
Langage dominant
JavaScript
Étoiles
6k
Forks
1.3k
Merge moyen
1 j 3 h
PR mergées (30 j)
611

Description

### Description

This RFC proposes the addition of a Time Series Generation module to `@stdlib/time` module. This module will facilitate the creation of sequences of dates or timestamps based on various patterns or intervals, catering to the needs of applications requiring regularly spaced time data.

The Time Series Generation module will offer flexibility in defining intervals, allowing users to specify common patterns such as daily, weekly, monthly, quarterly, or yearly intervals. Additionally, users will have the option to define custom intervals with arbitrary durations to suit specific requirements.

Key features of the Time Series Generation module include support for specifying start and end dates for the time series, handling of leap years.

This module aims to provide a convenient and efficient solution for generating time series data, enabling users to perform tasks such as financial analysis, data visualization, and scheduling with ease and accuracy.

Example for how this function can be called
```js
const { generateTimeSeries } = require('@stdlib/time');

const startDate = new Date('2024-01-01');
const endDate = new Date('2024-12-31');

const customSeries = generateTimeSeries({
interval: {
unit: 'month',
value: 3 // every 3 months
},
start: startDate,
end: endDate,
format: 'YYYY-MM-DD'
});

console.log(customSeries);
/*
[
'2024-01-01',
'2024-04-01',
'2024-07-01',
'2024-10-01'
]
*/
```

If this feature request gets the green light, I'd be happy trying implementing it.

### Related Issues

N/A

### Questions

No.

### Other

No.

### Checklist

- [X] I have read and understood the [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md).
- [X] Searched for existing issues and pull requests.
- [X] The issue name begins with `RFC:`.

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.