31:[] 2f:{"title":"Compromise-numbers","cells":[{"id":0,"value":"md`# Compromise-numbers\n\n**[compromise](https://beta.observablehq.com/@spencermountain/nlp-compromise)** can find, interpret, and transform numbers written in plain text, like *'two hundred'*, or *'9 million'*.\n\nThis is pretty-handy when doing any machine-interpretation of text, to normalize how numbers appear in a text.\n\n--- \ntry it out:\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":27,"value":"viewof text=html``","pinned":false,"hidden":false,"mode":"ojs"},{"id":31,"value":"{\n let num = nlp(text).values(0).toNumber().out()\n return html`

${num}

`\n}\n","pinned":false,"hidden":false,"mode":"ojs"},{"id":52,"value":"md` compromise can also convert numbers the other way, to a written-form:\n\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":57,"value":"viewof number=html``","pinned":false,"hidden":false,"mode":"ojs"},{"id":75,"value":"{\n let text = nlp(number).values(0).toText().out()\n return html`

${text}

`\n}\n","pinned":false,"hidden":false,"mode":"ojs"},{"id":91,"value":"md`\n\n---\n\n## Cardinal/Ordinal conversion:\n\nan **ordinal** is a form: \\`3rd\\`, or \\`third\\`. \n\na cardinal is the form \\`3\\` or \\`three\\`.\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":116,"value":"viewof cardinal = html``","pinned":false,"hidden":false,"mode":"ojs"},{"id":120,"value":"{ \n let text = nlp(cardinal).values().toOrdinal().out('text')\n return html`

${text}

`\n}","pinned":false,"hidden":false,"mode":"ojs"},{"id":93,"value":"viewof ordinal=html``","pinned":false,"hidden":false,"mode":"ojs"},{"id":96,"value":"{ \n let text = nlp(ordinal).values().toCardinal().out('text')\n return html`

${text}

`\n}","pinned":false,"hidden":false,"mode":"ojs"},{"id":142,"value":"md`\nto grab all the numberical information in a document, call **.values():**\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":145,"value":"{\n let doc = nlp(\"i have two questions for Homer - 'Why lie?' and 'Lies, why?'\")\n //get all numbers, in any form\n let nums = doc.values()\n return nums.out('array')\n}","pinned":true,"hidden":false,"mode":"ojs"},{"id":151,"value":"md`\n---\n## **.numbers()**:\njust get em all.\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":157,"value":"md`### **.json()**:\nget number and term metadata, as output.\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":365,"value":"nlp(`why can't I have no kids and three money?`).numbers().json()[0]","pinned":true,"hidden":false,"mode":"ojs"},{"id":392,"value":"","pinned":true,"hidden":false,"mode":"ojs"},{"id":209,"value":"md`\n### **.money()**\nthings like \\`'$2.50'\\`\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":212,"value":"md`\n### **.fractions()**\nthings like \\`1/3rd\\`\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":218,"value":"md`\n---\n### **.toText()**\nconvert number to \\`five\\` or \\`fifth\\`\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":350,"value":"{\n let doc = nlp('she is 5 years old')\n doc.numbers().toText()\n return doc.text()\n}","pinned":true,"hidden":false,"mode":"ojs"},{"id":221,"value":"md`\n### **.toNumber()**\nconvert number to \\`5\\` or \\`5th\\`\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":355,"value":"{\n let doc = nlp('she is five years old')\n doc.numbers().toNumber()\n return doc.text()\n}","pinned":true,"hidden":false,"mode":"ojs"},{"id":224,"value":"md`\n### **.toOrdinal()**\nconvert number to \\`fifth\\` or \\`5th\\`\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":359,"value":"{\n let doc = nlp('five bottles of beer')\n doc.numbers().toOrdinal()\n return doc.text()\n}","pinned":true,"hidden":false,"mode":"ojs"},{"id":227,"value":"md`\n### **.toCardinal()**\nconvert number to \\`five\\` or \\`5\\`\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":361,"value":"{\n let doc = nlp('fifth bottle of beer')\n doc.numbers().toCardinal()\n return doc.text()\n}","pinned":true,"hidden":false,"mode":"ojs"},{"id":194,"value":"\nmd`\n### **.toLocaleString()**\nadd commas, or nicer formatting for numbers\\`\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":363,"value":"nlp('$78392').numbers().toLocaleString().text()","pinned":true,"hidden":false,"mode":"ojs"},{"id":230,"value":"md`\n---\n### **.set(n,** *[agree]* **)**\nset number to n.\n\nthe given number gets fully-parsed along with the document numbers, and the internal tags of the number are always respected, so you can do things like this:\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":328,"value":"nlp('742 Evergreen Terrace').numbers().set('eleven').text()","pinned":true,"hidden":false,"mode":"ojs"},{"id":331,"value":"md`\n***[agree]*** - the second parameter determines whether compromise should attempt to convert the number's units between plural/singular. It can ensure the plural/singular state of the unit remains valid. \n- \\`'one tomato'\\`\n- \\`'two tomatoes'\\`\n\nThe param is optional and defaults to true.`","pinned":false,"hidden":false,"mode":"ojs"},{"id":346,"value":"{\n return {\n 'true': nlp('fourteen years old').numbers().set(1, true).all().text(), //agreement (default)\n 'false': nlp('fourteen years old').numbers().set(1, false).all().text(), //no agreement\n }\n}","pinned":true,"hidden":false,"mode":"ojs"},{"id":303,"value":"md`### **.add(n,** *[agree]* **)**\nincrease number by n\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":233,"value":"md`\n### **.subtract(n,** *[agree]* **)**\ndecrease number by n\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":323,"value":"{\n let doc = nlp('three bottles of beer')\n doc.numbers().minus(2)\n return doc.text()\n}","pinned":true,"hidden":false,"mode":"ojs"},{"id":236,"value":"md`\n### **.increment(n,** *[agree]* **)**\nincrease number by 1\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":239,"value":"md`\n### **.decrement(n,** *[agree]* **)**\ndecrease number by 1\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":325,"value":"{\n let doc = nlp('one bottle of beer')\n doc.numbers().decrement()\n return doc.text()\n}","pinned":true,"hidden":false,"mode":"ojs"},{"id":242,"value":"md`\n---\n### **.isEqual(n)**\nreturn numbers with this value\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":245,"value":"md`\n### **.greaterThan(max)**\nreturn numbers bigger than n\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":248,"value":"\nmd`\n### **.lessThan(min)**\nreturn numbers smaller than n\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":251,"value":"\n\nmd`\n### **.between(min, max)**\nvalues)** - return numbers between min and max\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":254,"value":"\n\nmd`\n### **.isOrdinal()**\nreturn only ordinal numbers\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":257,"value":"md`\n### **.isCardinal()**\nreturn only cardinal numbers\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":83,"value":"md`\n---\n### Tags\n\nin a document, this flexibility with numbers is understood using the following part-of-speech tags:`","pinned":false,"hidden":false,"mode":"ojs"},{"id":85,"value":"html`\n

#Value:

#Ordinal - like '5th' or 'fifth'

\n #Cardinal - like '5' or 'five'\n

#RomanNumeral - like 'CVII'

#Multiple - like 'hundred' or 'million'

#Fraction - like '1/3rd'

#TextValue - like 'five' or 'fifth'

#NumericValue - like '5' or '5th'

#Percent - '5.5%'

#Money - like '$5.50' or 'twenty euros'

\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":401,"value":"\n----\n\n### See also:\n* **[nouns](https://observablehq.com/@spencermountain/nouns)**\n* **[verbs](https://observablehq.com/@spencermountain/verbs)**\n* **[numbers](https://observablehq.com/@spencermountain/compromise-values)**\n* **[dates](https://observablehq.com/@spencermountain/compromise-dates)**\n","pinned":false,"hidden":false,"mode":"md"},{"id":38,"value":"style=html`\n\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":8,"value":"nlp = {\n let nlp = await require('compromise')\n let plugin = await require('compromise-numbers')\n nlp.extend(plugin)\n return nlp\n}","pinned":false,"hidden":false,"mode":"ojs"},{"id":10,"value":"wtf = require(\"wtf_wikipedia\")","pinned":false,"hidden":false,"mode":"ojs"},{"id":388,"value":"nlp.version","pinned":false,"hidden":false,"mode":"ojs"}],"files":"$W31","stdlib":"1","titling":"auto"}