Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/datasets-harrison-boston-house-prices-corrected

A (corrected) dataset derived from information collected by the US Census Service concerning housing in Boston, Massachusetts (1978).
https://github.com/stdlib-js/datasets-harrison-boston-house-prices-corrected

boston data dataset datasets house housing javascript linear-regression node node-js nodejs prediction prices statistics stats stdlib value

Last synced: about 2 months ago
JSON representation

A (corrected) dataset derived from information collected by the US Census Service concerning housing in Boston, Massachusetts (1978).

Awesome Lists containing this project

README 

        



  

    About stdlib...

  

  
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.


  
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.


  
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.


  
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!



# Boston House Prices



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



> A (corrected) dataset derived from information collected by the US Census Service concerning housing in Boston, Massachusetts (1978).



## Installation



```bash

npm install @stdlib/datasets-harrison-boston-house-prices-corrected

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).

-   To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

var dataset = require( '@stdlib/datasets-harrison-boston-house-prices-corrected' );

```



#### dataset()



Returns a (corrected) dataset derived from information collected by the US Census Service concerning housing in Boston, Massachusetts (1978).



```javascript

var data = dataset();

/* returns

    [

        {

            'crim': 0.00632,

            'zn': 18.00,

            'indus': 2.310,

            'chas': 0,

            'nox': 0.5380,

            'rm': 6.5750,

            'age': 65.20,

            'dis': 4.0900,

            'rad': 1,

            'tax': 296.0,

            'ptratio': 15.30,

            'b': 396.90,

            'lstat': 4.98,

            'medv': 24.00,

            'cmedv': 24.00

        },

        ...

    ]

*/

```



## Notes



-   The data consists of 15 attributes:



    -   **crim**: per capita crime rate by town

    -   **zn**: proportion of residential land zoned for lots over 25,000 square feet

    -   **indus**: proportion of non-retail business acres per town

    -   **chas**: Charles River dummy variable (`1` if tract bounds river; `0` otherwise)

    -   **nox**: nitric oxides concentration (parts per 10 million)

    -   **rm**: average number of rooms per dwelling

    -   **age**: proportion of owner-occupied units built prior to 1940

    -   **dis**: weighted distances to five Boston employment centers

    -   **rad**: index of accessibility to radial highways

    -   **tax**: full-value property-tax rate per $10,000

    -   **ptratio**: pupil-teacher ratio by town

    -   **b**: `1000(Bk-0.63)^2` where `Bk` is the proportion of blacks by town

    -   **lstat**: percent lower status of the population

    -   **medv**: median value of owner-occupied homes in $1000's

    -   **cmedv**: corrected median value of owner-occupied homes in $1000's



-   The dataset can be used to predict two dependent variables: 1) nitrous oxide level and 2) median home value.



-   The median home value field seems to be censored at `50.00` (corresponding to a median value of $50,000). Censoring is suggested by the fact that the highest median value of exactly $50,000 is reported in 16 cases, while 15 cases have values between $40,000 and $50,000. Values are rounded to the nearest hundred. Harrison and Rubinfeld do not, however, mention any censoring.



-   The dataset contains eight corrections to miscoded median values, as documented by [Gilley and Pace (1996)][@gilley:1996a].



## Examples



```javascript

var Plot = require( '@stdlib/plot' );

var dataset = require( '@stdlib/datasets-harrison-boston-house-prices-corrected' );



var data;

var plot;

var opts;

var x;

var y;

var i;



data = dataset();



// Extract housing data...

x = [];

y = [];

for ( i = 0; i < data.length; i++ ) {

    x.push( data[ i ].rm );

    y.push( data[ i ].cmedv );

}



// Create a plot instance:

opts = {

    'lineStyle': 'none',

    'symbols': 'closed-circle',

    'xLabel': 'Average Number of Rooms',

    'yLabel': 'Corrected Median Value',

    'title': 'Number of Rooms vs Median Value'

};

plot = new Plot( [ x ], [ y ], opts );



// Render the plot:

console.log( plot.render( 'html' ) );

```



* * *



## CLI



## Installation



To use as a general utility, install the CLI package globally



```bash

npm install -g @stdlib/datasets-harrison-boston-house-prices-corrected-cli

```



### Usage



```text

Usage: harrison-boston-house-prices-corrected [options]



Options:



  -h,    --help                Print this message.

  -V,    --version             Print the package version.

         --format fmt          Output format: 'csv' or 'ndjson'.

```



### Notes



-   The CLI supports two output formats: comma-separated values ([CSV][csv]) and newline-delimited JSON ([NDJSON][ndjson]). The default output format is [CSV][csv].



### Examples



```bash

$ harrison-boston-house-prices-corrected

```



* * *



## References



-   Harrison, David, and Daniel L Rubinfeld. 1978. "Hedonic housing prices and the demand for clean air." _Journal of Environmental Economics and Management_ 5 (1): 81–102. doi:[10.1016/0095-0696(78)90006-2][@harrison:1978a].

-   Gilley, Otis W., and R.Kelley Pace. 1996. "On the Harrison and Rubinfeld Data." _Journal of Environmental Economics and Management_ 31 (3): 403–5. doi:[10.1006/jeem.1996.0052][@gilley:1996a].



## 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].



* * *



## See Also



-   [`@stdlib/datasets-harrison-boston-house-prices`][@stdlib/datasets/harrison-boston-house-prices]: A dataset derived from information collected by the US Census Service concerning housing in Boston, Massachusetts (1978).

-   [`@stdlib/datasets-pace-boston-house-prices`][@stdlib/datasets/pace-boston-house-prices]: A (corrected) dataset derived from information collected by the US Census Service concerning housing in Boston, Massachusetts (1978).



* * *



## 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 © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/datasets-harrison-boston-house-prices-corrected.svg

[npm-url]: https://npmjs.org/package/@stdlib/datasets-harrison-boston-house-prices-corrected



[test-image]: https://github.com/stdlib-js/datasets-harrison-boston-house-prices-corrected/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/datasets-harrison-boston-house-prices-corrected/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/datasets-harrison-boston-house-prices-corrected/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/datasets-harrison-boston-house-prices-corrected?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[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-harrison-boston-house-prices-corrected#cli

[cli-url]: https://github.com/stdlib-js/datasets-harrison-boston-house-prices-corrected/tree/cli

[@stdlib/datasets-harrison-boston-house-prices-corrected]: https://github.com/stdlib-js/datasets-harrison-boston-house-prices-corrected/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-harrison-boston-house-prices-corrected/tree/deno

[deno-readme]: https://github.com/stdlib-js/datasets-harrison-boston-house-prices-corrected/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/datasets-harrison-boston-house-prices-corrected/tree/umd

[umd-readme]: https://github.com/stdlib-js/datasets-harrison-boston-house-prices-corrected/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/datasets-harrison-boston-house-prices-corrected/tree/esm

[esm-readme]: https://github.com/stdlib-js/datasets-harrison-boston-house-prices-corrected/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/datasets-harrison-boston-house-prices-corrected/blob/main/branches.md



[@harrison:1978a]: https://doi.org/10.1016/0095-0696%2878%2990006-2



[@gilley:1996a]: https://doi.org/10.1006/jeem.1996.0052



[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



[@stdlib/datasets/harrison-boston-house-prices]: https://github.com/stdlib-js/datasets-harrison-boston-house-prices



[@stdlib/datasets/pace-boston-house-prices]: https://github.com/stdlib-js/datasets-pace-boston-house-prices