Add README

kgryte · kgryte · commit 84baf2c9e6c8 · 2017-06-27T10:25:54.000-07:00
diff --git a/lib/node_modules/@stdlib/datasets/spam-assassin/README.md b/lib/node_modules/@stdlib/datasets/spam-assassin/README.md
@@ -0,0 +1,154 @@
+# Spam Assassin
+
+> The [Spam Assassin][spam-assassin] public mail corpus.
+
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+
+<section class="usage">
+
+## Usage
+
+``` javascript
+var corpus = require( '@stdlib/datasets/spam-assassin' );
+```
+
+#### corpus()
+
+Returns the [Spam Assassin][spam-assassin] public mail corpus.
+
+``` javascript
+var data = corpus();
+// returns [{...},{...},...]
+```
+
+Each `array` element has the following fields:
+
+* `id`: message id (relative to message `group`)
+* `group`: message group
+* `checksum`: object containing checksum info
+* `text`: message text (including headers)
+
+The message `group` may be one of the following:
+
+* `easy-ham-1`: easier to detect non-spam e-mails (2500 messages)
+* `easy-ham-2`: easier to detect non-spam e-mails collected at a later date (1400 messages)
+* `hard-ham-1`: harder to detect non-spam e-mails (250 messages)
+* `spam-1`: spam e-mails (500 messages)
+* `spam-2`: spam e-mails collected at a later date (1396 messages)
+
+The `checksum` object contains the following fields:
+
+* `type`: checksum type (e.g., MD5)
+* `value`: checksum value
+
+</section>
+
+<!-- /.usage -->
+
+
+<section class="examples">
+
+## Examples
+
+<!-- TODO: better example. Possibly a spam classifier. -->
+
+``` javascript
+var corpus = require( '@stdlib/datasets/spam-assassin' );
+
+var data;
+var i;
+
+data = corpus();
+for ( i = 0; i < data.length; i++ ) {
+    console.log( 'Character Count: %d', data[ i ].text.length );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+
+---
+
+<section class="cli">
+
+## CLI
+
+<section class="usage">
+
+### Usage
+
+``` bash
+Usage: spam-assassin [options]
+
+Options:
+
+  -h,    --help                Print this message.
+  -V,    --version             Print the package version.
+         --format fmt          Output format: 'txt' or 'ndjson'.
+```
+
+</section>
+
+<!-- /.usage -->
+
+
+<section class="notes">
+
+### Notes
+
+* The CLI supports two output formats: plain text (`txt`) and newline-delimited JSON ([NDJSON][ndjson]). The default output format is `txt`.
+
+</section>
+
+<!-- /.notes -->
+
+
+<section class="examples">
+
+### Examples
+
+``` bash
+$ spam-assassin
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.cli -->
+
+
+<!-- <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 [Creative Commons Zero v1.0 Universal][cc0]. The software is licensed under [Apache License, Version 2.0][apache-license].
+
+<!-- </license> -->
+
+
+<section class="links">
+
+[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
+
+[ndjson]: http://specs.frictionlessdata.io/ndjson/
+
+[spam-assassin]: http://spamassassin.apache.org/old/publiccorpus/readme.html
+
+</section>
+
+<!-- /.links -->
