Given a road network and a set of address points as line delimited geojson; output an interpolation network.
\n\n
\n \n \n \n \n \n
\n\n
\n \n
\n\n## `map` Mode\n\n### Basic Usage\n\n`map` mode is the core mode that PT2ITP exposes. It is responsible for taking the input street network and address points\nand generating the interpolation network.\n\nBasic Usage:\n```\n./index.js map --in-network= --in-address= --output= --languages=en --db \n```\n\nFull Options:\n```\n./index.js map --help\n```\n\n### Input Data\n\n#### Address Input\n\nInput line-delimited geojson features of points. Each point should have a property called `street` containing the street name\nand `number` containing the street address.\n\nAddresses can have any number of name synonyms of equal or differing priority.\n\n#### Properties\n\n| Property | Function |\n| :------: | -------- |\n| `number` | `String` The Housenumber for a given pt including any unit information. ie: `10a` |\n| `street` | `String` or `Array` The name of the street - preferably non-abbreviated. If it's an array, it must contain an object for each street name synonym with the properties `display` for the street name and `priority` for the numeric ranking. |\n| `source` | `String` The source name of the data so a single input file can have a combination of multiple sources |\n| `output` | `Boolean` A boolean allowing pts to be used to calculate the ITP segment but not output in the final cluster |\n| `interpolate` | `Boolean` A boolean, when set to false, keeps the address as an orphan address by skipping its inclusion in the ITP process |\n\n##### Example\n\n```\n{ \"type\": \"Feature\", \"geometry\": { \"type\": \"Point\", ... }, \"properties\": { \"street\": \"Main Street\", \"number\": 10 } }\n{ \"type\": \"Feature\", \"geometry\": { \"type\": \"Point\", ... }, \"properties\": { \"street\": [ { display: \"Main Street\", priority: 0 } ], \"number\": 11 } }\n...\n```\n\n#### Street Network Input\n\nInput line-delimited geojson features of lines. Each line should have a property called `street` containing the street name.\n\n**Note**: Networks can have any number of name synonyms but must have one name feature that has a priority level higher than the other synonyms.\n\n##### Example\n\n```\n{ \"type\": \"Feature\", \"geometry\": { \"type\": \"LineString\", ... }, \"properties\": { \"street\": \"Main Street\" } }\n{ \"type\": \"Feature\", \"geometry\": { \"type\": \"LineString\", ... }, \"properties\": { \"street\": \"Main Street\" } }\n...\n```\n\n## `conflate` Mode\n\n### Basic Usage\n\nCONFLATE MODE\n\nBasic Usage:\n```\n./index.js conflate --in-address= --in-persistent= --output= --tokens=en --db \n```\n\nFull Options:\n```\n./index.js conflate --help\n```\n\n### Input Data\n\n#### Persistent Address Input\n\nCONFLATE MODE PERSISTENT ADDRESS\n\n#### Properties\n\n| Property | Function |\n| :------: | -------- |\n| `` | ``\n\n##### Example\n\n```\n```\n\n#### Conflate Address Input\n\n##### Example\n\n```\n...\n```\n\n### Output Format\n\n\n## `convert` Mode\n\n### Basic Usage\n\nConverts the PT2ITP standard of line delimited geojson features into the more widely\nsupported GeoJSON FeatureCollections. Note that since GeoJSON is a text based format\nthis should not be used for huge numbers of features as most parsing software will\nrun out of memory.\n\nBasic Usage:\n```\n./index.js convert --input linedelimited.geojson --output featurecollection.geojson\n```\n\nFull Options:\n```\n./index.js convert --help\n```\n\n## `analyze` Mode\n\n### Basic Usage\n\nAnalyzes the name field of a set of address and network data from either the database or a GeoJSON file. Outputs a CSV and markdown summary of the frequency distribution of each token in the data. Also includes a comparison mode for comparing address and network tokens.\n\nBasic Usage:\n```\n./index.js analyze --cc us_ia --type address --output=/tmp/us_ia.text-analysis/address\n```\n\n## `consensus` Mode\n\n### Basic Usage\n\nTakes in multiple sets of address points, links addresses together using a set of query points, and calculates agreement metrics for each set of linked addresses.\n\nBasic Usage:\n```\n./index.js consensus linedelimited1.geojson linedelimited2.geojson linedelimited3.geojson --query_points linedelimited.geojson --db consensus --languages en --country us\n```\n\nFull Options:\n```\n./index.js consensus --help\n```\n\n## Version Numbers\n\nPT2ITP follows the [Semver](http://semver.org/) spec for it's **CLI interface**.\n\nThis means that breaking changes to the CLI tools will result in a `MAJOR` release.\nNew features will result in a `MINOR` release and bug fixes a `PATCH`.\n\nInternal functions may change in breaking ways with a `MINOR` release so long as they\ndon't change/break the CLI interface.\n\n## Terminology\n\n### Parts of an Address\n\n```\n123 1/2 West 1st Street\n┬── ┬── ┬─── ┬┬─ ┬\n│ │ │ ││ └┤ Suffix, Street Type - The type of street, ie: highway, street, circle.\n│ │ │ ││ │ rules for suffixes will differ per county/municipality\n│ │ │ ││\n│ │ │ │└┤ Ordinal Indicator - The group of characters, following a numeral denoting that it is an ordinal number\n│ │ │ │\n│ │ │ └┤ Ordinal - The numberic portional of a street name - must be followed by an ordinal indicator\n│ │ │\n│ │ └┤ Precardinal, predirectional - The compass direction preceeding the street name\n│ │\n│ └┤ Fractional Address\n│\n└┤ Primary Address Number\n\n\n\n289-1 Main Street Northeast APT 4\n┬──── ┬──────── ┬── ┬\n│ │ │ └┤ Secondary Address\n│ │ │\n│ │ └┤ Secondary Address Address Designator\n│ │ │ Common types include Apartment=APT, Building=BLDG\n│ │ │ Floor=FL, Suite=STE, Unit, ROOM=RM, Department=Dept\n│ │ │ the # sign can be used if the specific type is not covered\n│ │\n│ └┤ postcardinal, postdirectional\n│\n└┤ Hypenated Primary Address Number - The hyphen is significant and should not be omitted.\n │ Different hyphenated standards represent different things. wikipedia: Queens Addresses\n```\n\n## Tests\n\nTo run the entire JS & Rust test suite:\n\n```\nnpm run test\n```\n\nTo run only the Cargo test suite:\n\n```\nnpm run cargo\n```\n\nTo run a specific Cargo test:\n\n```\nnpm run cargo_individual --my_test=\n```\n\n- This will run only the test you specify (ie. `npm run cargo_one --my_test=util::linker::tests::test_be_linker`), as well as print any print statements you have added throughout your code.\n\n\n## Setup\n\nSince PT2ITP depends on some internal crates stored in private GitHub repos, you will also have to either [setup HTTPS access to private Mapbox repos](https://docs.github.com/en/github/using-git/updating-credentials-from-the-macos-keychain) or alias `https://github.com` for the ssh clone URL `git@github.com:` by running the following in the `pt2itp` repo:\n\n```sh\ngit config url.\"git@github.com:\".insteadOf \"https://github.com/\"\n```","readmeFilename":"README.md"}
![](\"https://coveralls.io/repos/github/ingalls/pt2itp/badge.svg?branch=master\"/){kind=icon}
\n ![](\"https://circleci.com/gh/ingalls/pt2itp/tree/master.svg?style=shield\"/)
\n ![](\"https://david-dm.org/ingalls/pt2itp.svg\"/)
\n ![](\"https://david-dm.org/ingalls/pt2itp/dev-status.svg\"/)
\n ![](\"https://badges.greenkeeper.io/ingalls/pt2itp.svg\"/)
\n![](\"https://nodei.co/npm/pt2itp.png?downloads=true&downloadRank=true\"/)
\n