[RFC]: add `stats/incr/nanmaape`
- Lenguaje dominante
- JavaScript
- Estrellas
- 6k
- Forks
- 1.3k
- Merge medio
- 1 d 3 h
- PR fusionados (30 d)
- 611
Descripción
## Description
This RFC proposes adding a new package to the `stats/incr/*` namespace: `@stdlib/stats/incr/nanmaape`.
This package is similar to [`@stdlib/stats/incr/maape`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/maape), except that it performs special handling of `NaN` values.
### Key Points
When implementing this package, you'll need to do the following:
#### Create package files
To see examples of similar packages, see [`@stdlib/stats/incr/maape`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/maape) (propagates `NaN` values) and [`@stdlib/stats/incr/nansum`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/nansum) (wraps a `NaN` propagating accumulator and skips `NaN` values).
In particular notice how `nansum` is a thin wrapper around `sum`. In most cases, this is what we are looking for.
While the package proposed in this RFC will **not** match the implementations found in the above packages, those packages should provide a conceptual idea of what is desired. Do **not** simply copy-paste the code found in those packages without reasoning about expected behavior and API design.
#### Update source files
Once you've created package files, proceed to update all tests, documentation, and examples to reflect the API and expected behavior for the package. You should spend some time studying the tests in [`@stdlib/stats/incr/maape`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/maape). We expect this package to have equivalent and fully comprehensive tests. The primary difference will be in the handling of `NaN` values.
To see an example of what is expected, study the tests in
- [`@stdlib/stats/incr/sum`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/sum) and [`@stdlib/stats/incr/nansum`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/nansum)
Compare and contrast the tests in that pair of packages.
#### Run tests and other commands
For each of the following commands, please run them from the root stdlib repository directory (not the package folder!).
To run unit tests,
```bash
make test TESTS_FILTER=".*/stats/incr/nanmaape/.*"
```
To run examples,
```bash
make examples EXAMPLES_FILTER=".*/stats/incr/nanmaape/.*"
```
To run benchmarks,
```bash
make benchmark BENCHMARKS_FILTER=".*/stats/incr/nanmaape/.*"
```
### Create pull request
Provided all tests, examples, and benchmarks successfully execute and pass and that you've updated the package's documentation, you are now ready to open a pull request!
* * *
## Notes
- If you are interested in contributing a PR which addresses this RFC and still getting familiar with our project conventions, please do **not** submit LLM-generated code. Please consult our [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) and the associated [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md). Failure to respect project conventions will result in your PR being rejected without review. Thank you for understanding!
### 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]:`.
Guía de contribución
Línea de trabajo
Start by comparing the package layouts and tests for @stdlib/stats/incr/maape, @stdlib/stats/incr/sum, and @stdlib/stats/incr/nansum. Clarify the expected NaN behavior and API from those examples, then create the package and update its tests, documentation, examples, and benchmarks. Run the three listed make commands from the repository root; done means all pass.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript
- Área
- data
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100