@stdlib/datasets-fivethirtyeight-ffq 0.0.7 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2021 The Stdlib Authors.
+Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md

@@ -18,9 +18,20 @@ 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>
+
 # FiveThirtyEight Food Frequency Questionnaire
 
-[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
 > [_FiveThirtyEight_][fivethirtyeight-nutrition-studies] reader responses to a food frequency questionnaire ([FFQ][ffq]).
 
@@ -109,62 +120,7 @@ console.log( results.print() );
 
 <!-- /.examples -->
 
-* * *
-
-<section class="cli">
-
-## CLI
-
-<section class="installation">
-
-## Installation
-
-To use the module as a general utility, install the module globally
-
-```bash
-npm install -g @stdlib/datasets-fivethirtyeight-ffq
-```
-
-</section>
-
-<section class="usage">
-
-### Usage
-
-```text
-Usage: fivethirtyeight-ffq [options]
-
-Options:
-
-  -h,    --help                Print this message.
-  -V,    --version             Print the package version.
-```
-
-</section>
-
-<!-- /.usage -->
-
-<section class="notes">
-
-### Notes
-
--   Data is written to `stdout` as comma-separated values ([CSV][csv]), where the first line is a header line.
-
-<section class="examples">
-
-### Examples
-
-```bash
-$ fivethirtyeight-ffq
-```
-
-</section>
-
-<!-- /.examples -->
-
-</section>
 
-<!-- /.cli -->
 
 * * *
 
@@ -186,6 +142,21 @@ The data files (databases) are licensed under an [Open Data Commons Attribution
 
 <!-- </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-fivethirtyeight-ffq-cli`][@stdlib/datasets-fivethirtyeight-ffq-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" >
 
@@ -205,7 +176,7 @@ For more information on the project, filing bug reports and feature requests, an
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -215,25 +186,43 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 
 <section class="links">
 
+[@stdlib/datasets-fivethirtyeight-ffq-cli]: https://www.npmjs.com/package/@stdlib/datasets-fivethirtyeight-ffq-cli
+
 [npm-image]: http://img.shields.io/npm/v/@stdlib/datasets-fivethirtyeight-ffq.svg
 [npm-url]: https://npmjs.org/package/@stdlib/datasets-fivethirtyeight-ffq
 
-[test-image]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/datasets-fivethirtyeight-ffq/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/datasets-fivethirtyeight-ffq?branch=main
 
+<!--
+
 [dependencies-image]: https://img.shields.io/david/stdlib-js/datasets-fivethirtyeight-ffq.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/datasets-fivethirtyeight-ffq/main
 
+-->
+
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[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-fivethirtyeight-ffq#cli
+[cli-url]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/tree/cli
+[@stdlib/datasets-fivethirtyeight-ffq]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/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-fivethirtyeight-ffq/tree/deno
+[umd-url]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/tree/umd
+[esm-url]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/tree/esm
+[branches-url]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/blob/main/branches.md
+
 [odc-by-1.0]: http://opendatacommons.org/licenses/by/1.0/
 
 [cc-by-4.0]: http://creativecommons.org/licenses/by/4.0/

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import dataset from '../docs/types/index';
+export = dataset;

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var s=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var t=s(function(f,a){
+var i=require("path").resolve,n=require('@stdlib/fs-read-json/dist').sync,o=i(__dirname,"..","data","data.json"),u={encoding:"utf8"};function v(){var r=n(o,u);if(r instanceof Error)throw r;return r}a.exports=v
+});var d=t();module.exports=d;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2019 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar resolve = require( 'path' ).resolve;\nvar readJSON = require( '@stdlib/fs-read-json' ).sync;\n\n\n// VARIABLES //\n\nvar fpath = resolve( __dirname, '..', 'data', 'data.json' );\nvar opts = {\n\t'encoding': 'utf8'\n};\n\n\n// MAIN //\n\n/**\n* Returns FiveThirtyEight reader responses to a food frequency questionnaire (FFQ).\n*\n* ## Notes\n*\n* -   This function synchronously reads data from disk for each invocation. Such behavior is intentional and so is the avoidance of `require`. We assume that invocations are infrequent, and we want to avoid the `require` cache. This means that we allow data to be garbage collected and a user is responsible for explicitly caching data.\n*\n* @throws {Error} unable to read data\n* @returns {ObjectArray} FFQ data\n*\n* @example\n* var data = dataset();\n* // returns [ {...}, ... ]\n*/\nfunction dataset() {\n\tvar data = readJSON( fpath, opts );\n\tif ( data instanceof Error ) {\n\t\tthrow data;\n\t}\n\treturn data;\n}\n\n\n// EXPORTS //\n\nmodule.exports = dataset;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2019 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* FiveThirtyEight reader responses to a food frequency questionnaire (FFQ).\n*\n* @module @stdlib/datasets-fivethirtyeight-ffq\n*\n* @example\n* var dataset = require( '@stdlib/datasets-fivethirtyeight-ffq' );\n* var data = dataset();\n* // returns [ {...}, ... ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,MAAO,EAAE,QAC5BC,EAAW,QAAS,sBAAuB,EAAE,KAK7CC,EAAQF,EAAS,UAAW,KAAM,OAAQ,WAAY,EACtDG,EAAO,CACV,SAAY,MACb,EAmBA,SAASC,GAAU,CAClB,IAAIC,EAAOJ,EAAUC,EAAOC,CAAK,EACjC,GAAKE,aAAgB,MACpB,MAAMA,EAEP,OAAOA,CACR,CAKAN,EAAO,QAAUK,IC5BjB,IAAIE,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "resolve", "readJSON", "fpath", "opts", "dataset", "data", "main"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Returns FiveThirtyEight reader responses to a food frequency questionnaire (FFQ).

package/lib/index.js

@@ -31,9 +31,9 @@
 
 // MODULES //
 
-var dataset = require( './main.js' );
+var main = require( './main.js' );
 
 
 // EXPORTS //
 
-module.exports = dataset;
+module.exports = main;

package/lib/main.js

@@ -41,7 +41,6 @@ var opts = {
 *
 * -   This function synchronously reads data from disk for each invocation. Such behavior is intentional and so is the avoidance of `require`. We assume that invocations are infrequent, and we want to avoid the `require` cache. This means that we allow data to be garbage collected and a user is responsible for explicitly caching data.
 *
-*
 * @throws {Error} unable to read data
 * @returns {ObjectArray} FFQ data
 *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/datasets-fivethirtyeight-ffq",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "FiveThirtyEight reader responses to a food frequency questionnaire (FFQ).",
   "license": "Apache-2.0",
   "author": {
@@ -13,9 +13,6 @@
       "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
     }
   ],
-  "bin": {
-    "fivethirtyeight-ffq": "./bin/cli"
-  },
   "main": "./lib",
   "browser": "./lib/browser.js",
   "directories": {
@@ -43,28 +40,14 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/cli-ctor": "^0.0.x",
-    "@stdlib/fs-read-file": "^0.0.x",
-    "@stdlib/fs-read-json": "^0.0.x",
-    "@stdlib/streams-node-stdout": "^0.0.x",
-    "@stdlib/utils-copy": "^0.0.x"
+    "@stdlib/fs-read-json": "^0.1.0",
+    "@stdlib/utils-copy": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/assert-is-array": "^0.0.x",
-    "@stdlib/assert-is-browser": "^0.0.x",
-    "@stdlib/assert-is-object-array": "^0.0.x",
-    "@stdlib/assert-is-windows": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/fs-write-file": "^0.0.x",
-    "@stdlib/process-exec-path": "^0.0.x",
-    "@stdlib/regexp-eol": "^0.0.x",
-    "@stdlib/stats-ttest2": "^0.0.x",
-    "@stdlib/utils-bifurcate-by": "^0.0.x",
-    "@stdlib/utils-inmap": "^0.0.x",
     "proxyquire": "^2.0.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -104,7 +87,7 @@
     "spurious"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/bin/cli

@@ -1,77 +0,0 @@
-#!/usr/bin/env node
-
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2019 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.
-*/
-
-'use strict';
-
-// MODULES //
-
-var createReadStream = require( 'fs' ).createReadStream;
-var resolve = require( 'path' ).resolve;
-var readFileSync = require( '@stdlib/fs-read-file' ).sync;
-var stdout = require( '@stdlib/streams-node-stdout' );
-var CLI = require( '@stdlib/cli-ctor' );
-
-
-// MAIN //
-
-/**
-* Main execution sequence.
-*
-* @private
-*/
-function main() {
-	var flags;
-	var fpath;
-	var cli;
-
-	// Create a command-line interface:
-	cli = new CLI({
-		'pkg': require( './../package.json' ),
-		'options': require( './../etc/cli_opts.json' ),
-		'help': readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
-			'encoding': 'utf8'
-		})
-	});
-
-	// Get any provided command-line options:
-	flags = cli.flags();
-	if ( flags.help || flags.version ) {
-		return;
-	}
-
-	// Resolve the data file path:
-	fpath = resolve( __dirname, '..', 'data', 'data.csv' );
-
-	// Print the data to stdout:
-	createReadStream( fpath )
-		.pipe( stdout )
-		.on( 'close', onClose );
-
-	/**
-	* Exits the CLI.
-	*
-	* @private
-	*/
-	function onClose() {
-		cli.close( 0 );
-	}
-}
-
-main();

package/docs/repl.txt

@@ -1,28 +0,0 @@
-
-{{alias}}()
-    Returns FiveThirtyEight reader responses to a food frequency questionnaire
-    (FFQ).
-
-    Returns
-    -------
-    out: Array<Object>
-        FiveThirtyEight reader responses to a food frequency questionnaire
-        (FFQ).
-
-    Examples
-    --------
-    > var data = {{alias}}()
-    [ {...}, ... ]
-
-    References
-    ----------
-    - Aschwanden, Christie. 2016. "You Can't Trust What You Read About
-    Nutrition." <https://fivethirtyeight.com/features/you-cant-trust-what-you-
-    read-about-nutrition/>.
-
-    * If you use the data for publication or third party consumption, please
-    cite the listed reference.
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,32 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2021 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.
-*/
-
-import dataset = require( './index' );
-
-
-// TESTS //
-
-// The function returns an array of objects...
-{
-	dataset(); // $ExpectType any[]
-}
-
-// The compiler throws an error if the function is provided arguments...
-{
-	dataset( 3.12 ); // $ExpectError
-}

package/docs/usage.txt

@@ -1,8 +0,0 @@
-
-Usage: fivethirtyeight-ffq [options]
-
-Options:
-
-  -h,    --help                Print this message.
-  -V,    --version             Print the package version.
-

package/etc/cli_opts.json

@@ -1,14 +0,0 @@
-{
-	"boolean": [
-		"help",
-		"version"
-	],
-	"alias": {
-		"help": [
-			"h"
-		],
-		"version": [
-			"V"
-		]
-	}
-}