npm package: @stdlib/datasets-nightingales-rose
Description: Dataset for Nightingale's famous polar area diagram.
Author: The Stdlib Authors
Latest version: 0.3.1

<!--

@license Apache-2.0

Copyright (c) 2018 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->


<details>
  <summary>
    About stdlib...
  </summary>
  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
</details>

# Nightingale's Rose

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->

> Dataset for [Florence Nightingale][nightingale]'s famous [polar area diagram][polar-area-diagram].

<section class="intro">

<!-- <image class="image" align="center" alt="Nightingale's famous polar area diagram."> -->

<div class="image" align="center">
    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@aeef456ddeeb9af2a4d17f11cb0e002fa5e535d6/lib/node_modules/%40stdlib/datasets/nightingales-rose/docs/img/charts.png" alt="Nightingale's famous polar area diagram.">
    <br>
</div>

<!-- </image> -->

</section>

<!-- /.intro -->

<section class="installation">

## Installation

```bash
npm install @stdlib/datasets-nightingales-rose
```

</section>

<section class="usage">

## Usage

```javascript
var rose = require( '@stdlib/datasets-nightingales-rose' );
```

#### rose()

Returns dataset for [Florence Nightingale][nightingale]'s famous [polar area diagram][polar-area-diagram].

```javascript
var data = rose();
/* returns
    [
        {
            'date': '1854-04-01T07:00:00.000Z',
            'army_size': 8571,
            'disease': 1,
            'wounds': 0,
            'other': 5
        },
        ...
    ]
*/
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var rose = require( '@stdlib/datasets-nightingales-rose' );

var scalar;
var data;
var d;
var i;

data = rose();

// As done by Nightingale, calculate the average annual mortality per 1000 for each cause. See http://understandinguncertainty.org/node/214.
for ( i = 0; i < data.length; i++ ) {
    d = data[ i ];
    scalar = 1000.0 * 12.0 / d.army_size;
    d.disease *= scalar;
    d.wounds *= scalar;
    d.other *= scalar;
}
console.dir( data );
```

</section>

<!-- /.examples -->



* * *

<section class="references">

## References

-   Nightingale, Florence. 1859. [_A contribution to the sanitary history of the British army during the late war with Russia_][@nightingale:1859a]. London, United Kingdom: John W. Parker and Son.

</section>

<!-- /.references -->

<!-- <license> -->

## License

The data files (databases) are licensed under an [Open Data Commons Public Domain Dedication & License 1.0][pddl-1.0] and their contents are licensed under a [Creative Commons Zero v1.0 Universal][cc0]. The software is licensed under [Apache License, Version 2.0][apache-license].

<!-- </license> -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

## See Also

-   <span class="package-name">[`@stdlib/datasets-nightingales-rose-cli`][@stdlib/datasets-nightingales-rose-cli]</span><span class="delimiter">: </span><span class="description">CLI package for use as a command-line utility.</span>


</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->


<section class="main-repo" >

* * *

## Notice

This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## Copyright

Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].

</section>

<!-- /.stdlib -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[@stdlib/datasets-nightingales-rose-cli]: https://www.npmjs.com/package/@stdlib/datasets-nightingales-rose-cli

[npm-image]: http://img.shields.io/npm/v/@stdlib/datasets-nightingales-rose.svg
[npm-url]: https://npmjs.org/package/@stdlib/datasets-nightingales-rose

[test-image]: https://github.com/stdlib-js/datasets-nightingales-rose/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/datasets-nightingales-rose/actions/workflows/test.yml?query=branch:v0.3.1

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/datasets-nightingales-rose/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/datasets-nightingales-rose?branch=main

<!--

[dependencies-image]: https://img.shields.io/david/stdlib-js/datasets-nightingales-rose.svg
[dependencies-url]: https://david-dm.org/stdlib-js/datasets-nightingales-rose/main

-->

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[cli-section]: https://github.com/stdlib-js/datasets-nightingales-rose#cli
[cli-url]: https://github.com/stdlib-js/datasets-nightingales-rose/tree/cli
[@stdlib/datasets-nightingales-rose]: https://github.com/stdlib-js/datasets-nightingales-rose/tree/main

[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/datasets-nightingales-rose/tree/deno
[deno-readme]: https://github.com/stdlib-js/datasets-nightingales-rose/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/datasets-nightingales-rose/tree/umd
[umd-readme]: https://github.com/stdlib-js/datasets-nightingales-rose/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/datasets-nightingales-rose/tree/esm
[esm-readme]: https://github.com/stdlib-js/datasets-nightingales-rose/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/datasets-nightingales-rose/blob/main/branches.md

[nightingale]: https://en.wikipedia.org/wiki/Florence_Nightingale

[polar-area-diagram]: https://en.wikipedia.org/wiki/Polar_area_diagram

[@nightingale:1859a]: https://id.lib.harvard.edu/curiosity/contagion/36-990101646750203941

[csv]: https://tools.ietf.org/html/rfc4180

[ndjson]: http://specs.frictionlessdata.io/ndjson/

[pddl-1.0]: http://opendatacommons.org/licenses/pddl/1.0/

[cc0]: https://creativecommons.org/publicdomain/zero/1.0

[apache-license]: https://www.apache.org/licenses/LICENSE-2.0

</section>

<!-- /.links -->