diff --git a/DESCRIPTION b/DESCRIPTION index 01c62a6..5e5bfb7 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: matsim Type: Package Title: R library for interfacing with MATSim agent-based microsimulation model -Version: 0.1.6 +Version: 0.1.7 Authors@R: c( person("Billy", "Charlton", email = "charlton@vsp.tu-berlin.de", role=c("aut","cre")), person("Oleksandr", "Soboliev", role="aut")) diff --git a/docs/404.html b/docs/404.html index d494806..650a373 100644 --- a/docs/404.html +++ b/docs/404.html @@ -24,7 +24,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/LICENSE.html b/docs/LICENSE.html index cb15919..ba21f40 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -10,7 +10,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/authors.html b/docs/authors.html index f04fe0b..68df583 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -10,7 +10,7 @@ matsim - 0.1.6 + 0.1.7 @@ -59,13 +59,13 @@ Citation Charlton B, Soboliev O (2022). matsim: R library for interfacing with MATSim agent-based microsimulation model. -R package version 0.1.6, https://github.com/matsim-vsp/matsim-r. +R package version 0.1.7, https://github.com/matsim-vsp/matsim-r. @Manual{, title = {matsim: R library for interfacing with MATSim agent-based microsimulation model}, author = {Billy Charlton and Oleksandr Soboliev}, year = {2022}, - note = {R package version 0.1.6}, + note = {R package version 0.1.7}, url = {https://github.com/matsim-vsp/matsim-r}, } diff --git a/docs/index.html b/docs/index.html index eb02ea4..e1848ea 100644 --- a/docs/index.html +++ b/docs/index.html @@ -44,7 +44,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index b71c988..e43ed1e 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: '2.18' pkgdown: 2.0.6 pkgdown_sha: ~ articles: {} -last_built: 2022-12-12T14:14Z +last_built: 2022-12-12T14:31Z urls: reference: https://vsp.berlin/matsim-r/reference article: https://vsp.berlin/matsim-r/articles diff --git a/docs/reference/compareBasePolicyOutput.html b/docs/reference/compareBasePolicyOutput.html index dc0f926..137d015 100644 --- a/docs/reference/compareBasePolicyOutput.html +++ b/docs/reference/compareBasePolicyOutput.html @@ -14,7 +14,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/compareBasePolicyShapeOutput.html b/docs/reference/compareBasePolicyShapeOutput.html index c271c08..89a7189 100644 --- a/docs/reference/compareBasePolicyShapeOutput.html +++ b/docs/reference/compareBasePolicyShapeOutput.html @@ -14,7 +14,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/compareTripTypesBarChart.html b/docs/reference/compareTripTypesBarChart.html index c0845ae..fb70654 100644 --- a/docs/reference/compareTripTypesBarChart.html +++ b/docs/reference/compareTripTypesBarChart.html @@ -14,7 +14,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/deriveODMatrix.html b/docs/reference/deriveODMatrix.html index 36f9f85..9615718 100644 --- a/docs/reference/deriveODMatrix.html +++ b/docs/reference/deriveODMatrix.html @@ -10,7 +10,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/filterByRegion.html b/docs/reference/filterByRegion.html index 8c46987..abce1eb 100644 --- a/docs/reference/filterByRegion.html +++ b/docs/reference/filterByRegion.html @@ -24,7 +24,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/generateXYHexagonYaml.html b/docs/reference/generateXYHexagonYaml.html index 6a2367d..ec6556d 100644 --- a/docs/reference/generateXYHexagonYaml.html +++ b/docs/reference/generateXYHexagonYaml.html @@ -10,7 +10,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/getCrsFromConfig.html b/docs/reference/getCrsFromConfig.html index 6403de3..7e548e2 100644 --- a/docs/reference/getCrsFromConfig.html +++ b/docs/reference/getCrsFromConfig.html @@ -14,7 +14,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/index.html b/docs/reference/index.html index a6e6290..6a7b19a 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -10,7 +10,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/loadNetwork.html b/docs/reference/loadNetwork.html index 56a1a5a..9766d31 100644 --- a/docs/reference/loadNetwork.html +++ b/docs/reference/loadNetwork.html @@ -14,7 +14,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotAverageTravelWait.html b/docs/reference/plotAverageTravelWait.html index 2498cbd..8b6e14a 100644 --- a/docs/reference/plotAverageTravelWait.html +++ b/docs/reference/plotAverageTravelWait.html @@ -16,7 +16,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotDistanceTraveledByType.html b/docs/reference/plotDistanceTraveledByType.html index ebccaec..41836ec 100644 --- a/docs/reference/plotDistanceTraveledByType.html +++ b/docs/reference/plotDistanceTraveledByType.html @@ -14,7 +14,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotEndActCountByArrTime.html b/docs/reference/plotEndActCountByArrTime.html index ff5b5c4..31b573d 100644 --- a/docs/reference/plotEndActCountByArrTime.html +++ b/docs/reference/plotEndActCountByArrTime.html @@ -16,7 +16,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotMapWithTrips.html b/docs/reference/plotMapWithTrips.html index 760ff4f..4a13a18 100644 --- a/docs/reference/plotMapWithTrips.html +++ b/docs/reference/plotMapWithTrips.html @@ -24,7 +24,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotMapWithTripsType.html b/docs/reference/plotMapWithTripsType.html index bd93f1d..833b969 100644 --- a/docs/reference/plotMapWithTripsType.html +++ b/docs/reference/plotMapWithTripsType.html @@ -10,7 +10,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotModalShiftBar.html b/docs/reference/plotModalShiftBar.html index 5e3738d..14eff07 100644 --- a/docs/reference/plotModalShiftBar.html +++ b/docs/reference/plotModalShiftBar.html @@ -14,7 +14,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotModalShiftSankey.html b/docs/reference/plotModalShiftSankey.html index 90d0b3a..b219300 100644 --- a/docs/reference/plotModalShiftSankey.html +++ b/docs/reference/plotModalShiftSankey.html @@ -14,7 +14,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotModalSplitBarChart.html b/docs/reference/plotModalSplitBarChart.html index 46de610..429d998 100644 --- a/docs/reference/plotModalSplitBarChart.html +++ b/docs/reference/plotModalSplitBarChart.html @@ -14,7 +14,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotModalSplitPieChart.html b/docs/reference/plotModalSplitPieChart.html index d076bdf..a898833 100644 --- a/docs/reference/plotModalSplitPieChart.html +++ b/docs/reference/plotModalSplitPieChart.html @@ -14,7 +14,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotStartActCountByDepTime.html b/docs/reference/plotStartActCountByDepTime.html index a87171d..8ef25bb 100644 --- a/docs/reference/plotStartActCountByDepTime.html +++ b/docs/reference/plotStartActCountByDepTime.html @@ -16,7 +16,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotTripCountByDepTime.html b/docs/reference/plotTripCountByDepTime.html index 5fc817f..15d5b03 100644 --- a/docs/reference/plotTripCountByDepTime.html +++ b/docs/reference/plotTripCountByDepTime.html @@ -16,7 +16,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotTripDistanceByMode.html b/docs/reference/plotTripDistanceByMode.html index 14f415d..0663c14 100644 --- a/docs/reference/plotTripDistanceByMode.html +++ b/docs/reference/plotTripDistanceByMode.html @@ -16,7 +16,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotTripTypesPieChart.html b/docs/reference/plotTripTypesPieChart.html index 51ad847..0cd4d20 100644 --- a/docs/reference/plotTripTypesPieChart.html +++ b/docs/reference/plotTripTypesPieChart.html @@ -10,7 +10,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/plotTripsByDistance.html b/docs/reference/plotTripsByDistance.html index 7ee9eaa..64569fd 100644 --- a/docs/reference/plotTripsByDistance.html +++ b/docs/reference/plotTripsByDistance.html @@ -16,7 +16,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/prepareSimwrapperDashboardFromFolder.html b/docs/reference/prepareSimwrapperDashboardFromFolder.html index 482a83b..3ff8a8d 100644 --- a/docs/reference/prepareSimwrapperDashboardFromFolder.html +++ b/docs/reference/prepareSimwrapperDashboardFromFolder.html @@ -10,7 +10,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/prepareSimwrapperDashboardFromTable.html b/docs/reference/prepareSimwrapperDashboardFromTable.html index 4bebb2b..61e1e61 100644 --- a/docs/reference/prepareSimwrapperDashboardFromTable.html +++ b/docs/reference/prepareSimwrapperDashboardFromTable.html @@ -10,7 +10,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/readTripsTable.html b/docs/reference/readTripsTable.html index 8ff1d78..7a11871 100644 --- a/docs/reference/readTripsTable.html +++ b/docs/reference/readTripsTable.html @@ -12,7 +12,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/reference/transformToSf.html b/docs/reference/transformToSf.html index 4daf8da..f1d23d4 100644 --- a/docs/reference/transformToSf.html +++ b/docs/reference/transformToSf.html @@ -20,7 +20,7 @@ matsim - 0.1.6 + 0.1.7 diff --git a/docs/search.json b/docs/search.json index d64babd..5c68b31 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -[{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"GNU General Public License","title":"GNU General Public License","text":"Version 3, 29 June 2007Copyright © 2007 Free Software Foundation, Inc. Everyone permitted copy distribute verbatim copies license document, changing allowed.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"preamble","dir":"","previous_headings":"","what":"Preamble","title":"GNU General Public License","text":"GNU General Public License free, copyleft license software kinds works. licenses software practical works designed take away freedom share change works. contrast, GNU General Public License intended guarantee freedom share change versions program–make sure remains free software users. , Free Software Foundation, use GNU General Public License software; applies also work released way authors. can apply programs, . speak free software, referring freedom, price. General Public Licenses designed make sure freedom distribute copies free software (charge wish), receive source code can get want , can change software use pieces new free programs, know can things. protect rights, need prevent others denying rights asking surrender rights. Therefore, certain responsibilities distribute copies software, modify : responsibilities respect freedom others. example, distribute copies program, whether gratis fee, must pass recipients freedoms received. must make sure , , receive can get source code. must show terms know rights. Developers use GNU GPL protect rights two steps: (1) assert copyright software, (2) offer License giving legal permission copy, distribute /modify . developers’ authors’ protection, GPL clearly explains warranty free software. users’ authors’ sake, GPL requires modified versions marked changed, problems attributed erroneously authors previous versions. devices designed deny users access install run modified versions software inside , although manufacturer can . fundamentally incompatible aim protecting users’ freedom change software. systematic pattern abuse occurs area products individuals use, precisely unacceptable. Therefore, designed version GPL prohibit practice products. problems arise substantially domains, stand ready extend provision domains future versions GPL, needed protect freedom users. Finally, every program threatened constantly software patents. States allow patents restrict development use software general-purpose computers, , wish avoid special danger patents applied free program make effectively proprietary. prevent , GPL assures patents used render program non-free. precise terms conditions copying, distribution modification follow.","code":""},{"path":[]},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_0-definitions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"0. Definitions","title":"GNU General Public License","text":"“License” refers version 3 GNU General Public License. “Copyright” also means copyright-like laws apply kinds works, semiconductor masks. “Program” refers copyrightable work licensed License. licensee addressed “”. “Licensees” “recipients” may individuals organizations. “modify” work means copy adapt part work fashion requiring copyright permission, making exact copy. resulting work called “modified version” earlier work work “based ” earlier work. “covered work” means either unmodified Program work based Program. “propagate” work means anything , without permission, make directly secondarily liable infringement applicable copyright law, except executing computer modifying private copy. Propagation includes copying, distribution (without modification), making available public, countries activities well. “convey” work means kind propagation enables parties make receive copies. Mere interaction user computer network, transfer copy, conveying. interactive user interface displays “Appropriate Legal Notices” extent includes convenient prominently visible feature (1) displays appropriate copyright notice, (2) tells user warranty work (except extent warranties provided), licensees may convey work License, view copy License. interface presents list user commands options, menu, prominent item list meets criterion.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_1-source-code","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"1. Source Code","title":"GNU General Public License","text":"“source code” work means preferred form work making modifications . “Object code” means non-source form work. “Standard Interface” means interface either official standard defined recognized standards body, , case interfaces specified particular programming language, one widely used among developers working language. “System Libraries” executable work include anything, work whole, () included normal form packaging Major Component, part Major Component, (b) serves enable use work Major Component, implement Standard Interface implementation available public source code form. “Major Component”, context, means major essential component (kernel, window system, ) specific operating system () executable work runs, compiler used produce work, object code interpreter used run . “Corresponding Source” work object code form means source code needed generate, install, (executable work) run object code modify work, including scripts control activities. However, include work’s System Libraries, general-purpose tools generally available free programs used unmodified performing activities part work. example, Corresponding Source includes interface definition files associated source files work, source code shared libraries dynamically linked subprograms work specifically designed require, intimate data communication control flow subprograms parts work. Corresponding Source need include anything users can regenerate automatically parts Corresponding Source. Corresponding Source work source code form work.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_2-basic-permissions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"2. Basic Permissions","title":"GNU General Public License","text":"rights granted License granted term copyright Program, irrevocable provided stated conditions met. License explicitly affirms unlimited permission run unmodified Program. output running covered work covered License output, given content, constitutes covered work. License acknowledges rights fair use equivalent, provided copyright law. may make, run propagate covered works convey, without conditions long license otherwise remains force. may convey covered works others sole purpose make modifications exclusively , provide facilities running works, provided comply terms License conveying material control copyright. thus making running covered works must exclusively behalf, direction control, terms prohibit making copies copyrighted material outside relationship . Conveying circumstances permitted solely conditions stated . Sublicensing allowed; section 10 makes unnecessary.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_3-protecting-users-legal-rights-from-anti-circumvention-law","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"3. Protecting Users’ Legal Rights From Anti-Circumvention Law","title":"GNU General Public License","text":"covered work shall deemed part effective technological measure applicable law fulfilling obligations article 11 WIPO copyright treaty adopted 20 December 1996, similar laws prohibiting restricting circumvention measures. convey covered work, waive legal power forbid circumvention technological measures extent circumvention effected exercising rights License respect covered work, disclaim intention limit operation modification work means enforcing, work’s users, third parties’ legal rights forbid circumvention technological measures.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_4-conveying-verbatim-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"4. Conveying Verbatim Copies","title":"GNU General Public License","text":"may convey verbatim copies Program’s source code receive , medium, provided conspicuously appropriately publish copy appropriate copyright notice; keep intact notices stating License non-permissive terms added accord section 7 apply code; keep intact notices absence warranty; give recipients copy License along Program. may charge price price copy convey, may offer support warranty protection fee.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_5-conveying-modified-source-versions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"5. Conveying Modified Source Versions","title":"GNU General Public License","text":"may convey work based Program, modifications produce Program, form source code terms section 4, provided also meet conditions: ) work must carry prominent notices stating modified , giving relevant date. b) work must carry prominent notices stating released License conditions added section 7. requirement modifies requirement section 4 “keep intact notices”. c) must license entire work, whole, License anyone comes possession copy. License therefore apply, along applicable section 7 additional terms, whole work, parts, regardless packaged. License gives permission license work way, invalidate permission separately received . d) work interactive user interfaces, must display Appropriate Legal Notices; however, Program interactive interfaces display Appropriate Legal Notices, work need make . compilation covered work separate independent works, nature extensions covered work, combined form larger program, volume storage distribution medium, called “aggregate” compilation resulting copyright used limit access legal rights compilation’s users beyond individual works permit. Inclusion covered work aggregate cause License apply parts aggregate.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_6-conveying-non-source-forms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"6. Conveying Non-Source Forms","title":"GNU General Public License","text":"may convey covered work object code form terms sections 4 5, provided also convey machine-readable Corresponding Source terms License, one ways: ) Convey object code , embodied , physical product (including physical distribution medium), accompanied Corresponding Source fixed durable physical medium customarily used software interchange. b) Convey object code , embodied , physical product (including physical distribution medium), accompanied written offer, valid least three years valid long offer spare parts customer support product model, give anyone possesses object code either (1) copy Corresponding Source software product covered License, durable physical medium customarily used software interchange, price reasonable cost physically performing conveying source, (2) access copy Corresponding Source network server charge. c) Convey individual copies object code copy written offer provide Corresponding Source. alternative allowed occasionally noncommercially, received object code offer, accord subsection 6b. d) Convey object code offering access designated place (gratis charge), offer equivalent access Corresponding Source way place charge. need require recipients copy Corresponding Source along object code. place copy object code network server, Corresponding Source may different server (operated third party) supports equivalent copying facilities, provided maintain clear directions next object code saying find Corresponding Source. Regardless server hosts Corresponding Source, remain obligated ensure available long needed satisfy requirements. e) Convey object code using peer--peer transmission, provided inform peers object code Corresponding Source work offered general public charge subsection 6d. separable portion object code, whose source code excluded Corresponding Source System Library, need included conveying object code work. “User Product” either (1) “consumer product”, means tangible personal property normally used personal, family, household purposes, (2) anything designed sold incorporation dwelling. determining whether product consumer product, doubtful cases shall resolved favor coverage. particular product received particular user, “normally used” refers typical common use class product, regardless status particular user way particular user actually uses, expects expected use, product. product consumer product regardless whether product substantial commercial, industrial non-consumer uses, unless uses represent significant mode use product. “Installation Information” User Product means methods, procedures, authorization keys, information required install execute modified versions covered work User Product modified version Corresponding Source. information must suffice ensure continued functioning modified object code case prevented interfered solely modification made. convey object code work section , , specifically use , User Product, conveying occurs part transaction right possession use User Product transferred recipient perpetuity fixed term (regardless transaction characterized), Corresponding Source conveyed section must accompanied Installation Information. requirement apply neither third party retains ability install modified object code User Product (example, work installed ROM). requirement provide Installation Information include requirement continue provide support service, warranty, updates work modified installed recipient, User Product modified installed. Access network may denied modification materially adversely affects operation network violates rules protocols communication across network. Corresponding Source conveyed, Installation Information provided, accord section must format publicly documented (implementation available public source code form), must require special password key unpacking, reading copying.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_7-additional-terms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"7. Additional Terms","title":"GNU General Public License","text":"“Additional permissions” terms supplement terms License making exceptions one conditions. Additional permissions applicable entire Program shall treated though included License, extent valid applicable law. additional permissions apply part Program, part may used separately permissions, entire Program remains governed License without regard additional permissions. convey copy covered work, may option remove additional permissions copy, part . (Additional permissions may written require removal certain cases modify work.) may place additional permissions material, added covered work, can give appropriate copyright permission. Notwithstanding provision License, material add covered work, may (authorized copyright holders material) supplement terms License terms: ) Disclaiming warranty limiting liability differently terms sections 15 16 License; b) Requiring preservation specified reasonable legal notices author attributions material Appropriate Legal Notices displayed works containing ; c) Prohibiting misrepresentation origin material, requiring modified versions material marked reasonable ways different original version; d) Limiting use publicity purposes names licensors authors material; e) Declining grant rights trademark law use trade names, trademarks, service marks; f) Requiring indemnification licensors authors material anyone conveys material (modified versions ) contractual assumptions liability recipient, liability contractual assumptions directly impose licensors authors. non-permissive additional terms considered “restrictions” within meaning section 10. Program received , part , contains notice stating governed License along term restriction, may remove term. license document contains restriction permits relicensing conveying License, may add covered work material governed terms license document, provided restriction survive relicensing conveying. add terms covered work accord section, must place, relevant source files, statement additional terms apply files, notice indicating find applicable terms. Additional terms, permissive non-permissive, may stated form separately written license, stated exceptions; requirements apply either way.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_8-termination","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"8. Termination","title":"GNU General Public License","text":"may propagate modify covered work except expressly provided License. attempt otherwise propagate modify void, automatically terminate rights License (including patent licenses granted third paragraph section 11). However, cease violation License, license particular copyright holder reinstated () provisionally, unless copyright holder explicitly finally terminates license, (b) permanently, copyright holder fails notify violation reasonable means prior 60 days cessation. Moreover, license particular copyright holder reinstated permanently copyright holder notifies violation reasonable means, first time received notice violation License (work) copyright holder, cure violation prior 30 days receipt notice. Termination rights section terminate licenses parties received copies rights License. rights terminated permanently reinstated, qualify receive new licenses material section 10.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_9-acceptance-not-required-for-having-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"9. Acceptance Not Required for Having Copies","title":"GNU General Public License","text":"required accept License order receive run copy Program. Ancillary propagation covered work occurring solely consequence using peer--peer transmission receive copy likewise require acceptance. However, nothing License grants permission propagate modify covered work. actions infringe copyright accept License. Therefore, modifying propagating covered work, indicate acceptance License .","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_10-automatic-licensing-of-downstream-recipients","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"10. Automatic Licensing of Downstream Recipients","title":"GNU General Public License","text":"time convey covered work, recipient automatically receives license original licensors, run, modify propagate work, subject License. responsible enforcing compliance third parties License. “entity transaction” transaction transferring control organization, substantially assets one, subdividing organization, merging organizations. propagation covered work results entity transaction, party transaction receives copy work also receives whatever licenses work party’s predecessor interest give previous paragraph, plus right possession Corresponding Source work predecessor interest, predecessor can get reasonable efforts. may impose restrictions exercise rights granted affirmed License. example, may impose license fee, royalty, charge exercise rights granted License, may initiate litigation (including cross-claim counterclaim lawsuit) alleging patent claim infringed making, using, selling, offering sale, importing Program portion .","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_11-patents","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"11. Patents","title":"GNU General Public License","text":"“contributor” copyright holder authorizes use License Program work Program based. work thus licensed called contributor’s “contributor version”. contributor’s “essential patent claims” patent claims owned controlled contributor, whether already acquired hereafter acquired, infringed manner, permitted License, making, using, selling contributor version, include claims infringed consequence modification contributor version. purposes definition, “control” includes right grant patent sublicenses manner consistent requirements License. contributor grants non-exclusive, worldwide, royalty-free patent license contributor’s essential patent claims, make, use, sell, offer sale, import otherwise run, modify propagate contents contributor version. following three paragraphs, “patent license” express agreement commitment, however denominated, enforce patent (express permission practice patent covenant sue patent infringement). “grant” patent license party means make agreement commitment enforce patent party. convey covered work, knowingly relying patent license, Corresponding Source work available anyone copy, free charge terms License, publicly available network server readily accessible means, must either (1) cause Corresponding Source available, (2) arrange deprive benefit patent license particular work, (3) arrange, manner consistent requirements License, extend patent license downstream recipients. “Knowingly relying” means actual knowledge , patent license, conveying covered work country, recipient’s use covered work country, infringe one identifiable patents country reason believe valid. , pursuant connection single transaction arrangement, convey, propagate procuring conveyance , covered work, grant patent license parties receiving covered work authorizing use, propagate, modify convey specific copy covered work, patent license grant automatically extended recipients covered work works based . patent license “discriminatory” include within scope coverage, prohibits exercise , conditioned non-exercise one rights specifically granted License. may convey covered work party arrangement third party business distributing software, make payment third party based extent activity conveying work, third party grants, parties receive covered work , discriminatory patent license () connection copies covered work conveyed (copies made copies), (b) primarily connection specific products compilations contain covered work, unless entered arrangement, patent license granted, prior 28 March 2007. Nothing License shall construed excluding limiting implied license defenses infringement may otherwise available applicable patent law.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_12-no-surrender-of-others-freedom","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"12. No Surrender of Others’ Freedom","title":"GNU General Public License","text":"conditions imposed (whether court order, agreement otherwise) contradict conditions License, excuse conditions License. convey covered work satisfy simultaneously obligations License pertinent obligations, consequence may convey . example, agree terms obligate collect royalty conveying convey Program, way satisfy terms License refrain entirely conveying Program.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_13-use-with-the-gnu-affero-general-public-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"13. Use with the GNU Affero General Public License","title":"GNU General Public License","text":"Notwithstanding provision License, permission link combine covered work work licensed version 3 GNU Affero General Public License single combined work, convey resulting work. terms License continue apply part covered work, special requirements GNU Affero General Public License, section 13, concerning interaction network apply combination .","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_14-revised-versions-of-this-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"14. Revised Versions of this License","title":"GNU General Public License","text":"Free Software Foundation may publish revised /new versions GNU General Public License time time. new versions similar spirit present version, may differ detail address new problems concerns. version given distinguishing version number. Program specifies certain numbered version GNU General Public License “later version” applies , option following terms conditions either numbered version later version published Free Software Foundation. Program specify version number GNU General Public License, may choose version ever published Free Software Foundation. Program specifies proxy can decide future versions GNU General Public License can used, proxy’s public statement acceptance version permanently authorizes choose version Program. Later license versions may give additional different permissions. However, additional obligations imposed author copyright holder result choosing follow later version.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_15-disclaimer-of-warranty","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"15. Disclaimer of Warranty","title":"GNU General Public License","text":"WARRANTY PROGRAM, EXTENT PERMITTED APPLICABLE LAW. EXCEPT OTHERWISE STATED WRITING COPYRIGHT HOLDERS /PARTIES PROVIDE PROGRAM “” WITHOUT WARRANTY KIND, EITHER EXPRESSED IMPLIED, INCLUDING, LIMITED , IMPLIED WARRANTIES MERCHANTABILITY FITNESS PARTICULAR PURPOSE. ENTIRE RISK QUALITY PERFORMANCE PROGRAM . PROGRAM PROVE DEFECTIVE, ASSUME COST NECESSARY SERVICING, REPAIR CORRECTION.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_16-limitation-of-liability","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"16. Limitation of Liability","title":"GNU General Public License","text":"EVENT UNLESS REQUIRED APPLICABLE LAW AGREED WRITING COPYRIGHT HOLDER, PARTY MODIFIES /CONVEYS PROGRAM PERMITTED , LIABLE DAMAGES, INCLUDING GENERAL, SPECIAL, INCIDENTAL CONSEQUENTIAL DAMAGES ARISING USE INABILITY USE PROGRAM (INCLUDING LIMITED LOSS DATA DATA RENDERED INACCURATE LOSSES SUSTAINED THIRD PARTIES FAILURE PROGRAM OPERATE PROGRAMS), EVEN HOLDER PARTY ADVISED POSSIBILITY DAMAGES.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_17-interpretation-of-sections-15-and-16","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"17. Interpretation of Sections 15 and 16","title":"GNU General Public License","text":"disclaimer warranty limitation liability provided given local legal effect according terms, reviewing courts shall apply local law closely approximates absolute waiver civil liability connection Program, unless warranty assumption liability accompanies copy Program return fee. END TERMS CONDITIONS","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"how-to-apply-these-terms-to-your-new-programs","dir":"","previous_headings":"","what":"How to Apply These Terms to Your New Programs","title":"GNU General Public License","text":"develop new program, want greatest possible use public, best way achieve make free software everyone can redistribute change terms. , attach following notices program. safest attach start source file effectively state exclusion warranty; file least “copyright” line pointer full notice found. Also add information contact electronic paper mail. program terminal interaction, make output short notice like starts interactive mode: hypothetical commands show w show c show appropriate parts General Public License. course, program’s commands might different; GUI interface, use “box”. also get employer (work programmer) school, , sign “copyright disclaimer” program, necessary. information , apply follow GNU GPL, see . GNU General Public License permit incorporating program proprietary programs. program subroutine library, may consider useful permit linking proprietary applications library. want , use GNU Lesser General Public License instead License. first, please read .","code":" Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free software, and you are welcome to redistribute it under certain conditions; type 'show c' for details."},{"path":"https://vsp.berlin/matsim-r/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Billy Charlton. Author, maintainer. Oleksandr Soboliev. Author.","code":""},{"path":"https://vsp.berlin/matsim-r/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Charlton B, Soboliev O (2022). matsim: R library interfacing MATSim agent-based microsimulation model. R package version 0.1.6, https://github.com/matsim-vsp/matsim-r.","code":"@Manual{, title = {matsim: R library for interfacing with MATSim agent-based microsimulation model}, author = {Billy Charlton and Oleksandr Soboliev}, year = {2022}, note = {R package version 0.1.6}, url = {https://github.com/matsim-vsp/matsim-r}, }"},{"path":"https://vsp.berlin/matsim-r/index.html","id":"matsim-r-support-package","dir":"","previous_headings":"","what":"R library for interfacing with MATSim agent-based microsimulation model","title":"R library for interfacing with MATSim agent-based microsimulation model","text":"MATSim https://matsim.org agent-based microsimulation package large-scape transport simulations. package mimics functionality Python matsim-tools package, eventually support standard MATSim networks, plans events. Currently network files supported, many summarization plots based MATSim standard output_trips file. One useful command builds SimWrapper dashboard standard MATSim output_trips.xml.gz file: R -e \"prepareSimwrapperDashboardFromFolder()\" work preliminary ongoing – submissions welcome!","code":""},{"path":"https://vsp.berlin/matsim-r/index.html","id":"install","dir":"","previous_headings":"","what":"Install","title":"R library for interfacing with MATSim agent-based microsimulation model","text":"can install package right now: install.packages(\"devtools\") devtools::install_github(\"matsim-vsp/matsim-r\") install package specific branch use: devtools::install_github(\"matsim-vsp/matsim-r\",ref=\"{name branch}\")","code":""},{"path":"https://vsp.berlin/matsim-r/index.html","id":"installing-from-gz-archive","dir":"","previous_headings":"Install","what":"Installing from .gz archive","title":"R library for interfacing with MATSim agent-based microsimulation model","text":"Instead using devtools can also install directly source archive: install.packages(\"matsim-r.tar.gz\", type=\"source\", repos=NULL)","code":""},{"path":"https://vsp.berlin/matsim-r/index.html","id":"documentation-build-instructions","dir":"","previous_headings":"","what":"Documentation build instructions","title":"R library for interfacing with MATSim agent-based microsimulation model","text":"Run GNU Make build docs whenever source files R/ change. create man pages well fancy HTML docs/ folder , build : devtools::document() builds docs NAMESPACE pkgdown::build_site() builds HTML docs","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyOutput.html","id":null,"dir":"Reference","previous_headings":"","what":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyOutput","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyOutput","text":"Chooses function compare output_trips folders. baseFolder contains base outputs, policyFolder contains policy outputs.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyOutput.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyOutput","text":"","code":"compareBasePolicyOutput( baseFolder, policyFolder, dump.output.to = matsimDumpOutputDirectory )"},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyOutput.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyOutput","text":"baseFolder specifies data source folder multiple base output_trips policyFolder specifies data source folder multiple policy output_trips dump.output.saves result comparisons base policy. now creates plotModalShiftBar() output_trips","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyOutput.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyOutput","text":"list tibbles, list base policy output_trips tibble","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyShapeOutput.html","id":null,"dir":"Reference","previous_headings":"","what":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyShapeOutput","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyShapeOutput","text":"Chooses function compare output_trips folders. baseFolder contains base outputs, policyFolder contains policy outputs.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyShapeOutput.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyShapeOutput","text":"","code":"compareBasePolicyShapeOutput( baseFolder, policyFolder, shapeFilePath, crs, dump.output.to = matsimDumpOutputDirectory )"},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyShapeOutput.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyShapeOutput","text":"baseFolder specifies data source folder multiple base output_trips policyFolder specifies data source folder multiple policy output_trips shapeFilePath specifies shapeFile used comparison crs numeric EPSG code proj4string, can found network/config file output directory MATSim simulation dump.output.saves result comparisons base policy. now creates plotModalShiftBar() output_trips","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyShapeOutput.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyShapeOutput","text":"list tibbles, list base policy output_trips tibble","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareTripTypesBarChart.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates BarChart of changing trip types(originating,transit etc) between 2 tables\nand saves output to dump.output.to — compareTripTypesBarChart","title":"Creates BarChart of changing trip types(originating,transit etc) between 2 tables\nand saves output to dump.output.to — compareTripTypesBarChart","text":"Creates BarChart changing trip types(originating,transit etc) 2 tables saves output dump.output.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareTripTypesBarChart.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates BarChart of changing trip types(originating,transit etc) between 2 tables\nand saves output to dump.output.to — compareTripTypesBarChart","text":"","code":"compareTripTypesBarChart( tripsTable1, tripsTable2, shapeTable, crs, dump.output.to = matsimDumpOutputDirectory )"},{"path":"https://vsp.berlin/matsim-r/reference/compareTripTypesBarChart.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates BarChart of changing trip types(originating,transit etc) between 2 tables\nand saves output to dump.output.to — compareTripTypesBarChart","text":"tripsTable1 tibble trips_output (readTripsTable(),f.e. base case) tripsTable2 tibble trips_output (readTripsTable(),f.e. policy case) shapeTable sf object(data.frame geometries), can received using st_read(path_to_geographical_file) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation dump.output.folder saves resulting image BarChart","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareTripTypesBarChart.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates BarChart of changing trip types(originating,transit etc) between 2 tables\nand saves output to dump.output.to — compareTripTypesBarChart","text":"plot percentage type trips 2 tables","code":""},{"path":"https://vsp.berlin/matsim-r/reference/deriveODMatrix.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates an instance of ODMatrix(origin/destination) in conventional form or for the simwrapper — deriveODMatrix","title":"Creates an instance of ODMatrix(origin/destination) in conventional form or for the simwrapper — deriveODMatrix","text":"Creates instance ODMatrix(origin/destination) conventional form simwrapper","code":""},{"path":"https://vsp.berlin/matsim-r/reference/deriveODMatrix.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates an instance of ODMatrix(origin/destination) in conventional form or for the simwrapper — deriveODMatrix","text":"","code":"deriveODMatrix( tripsTable, shapePath, crs, dump.output.to = matsimDumpOutputDirectory, simwrapper = FALSE, colnames = \"numeric\", outer = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/deriveODMatrix.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates an instance of ODMatrix(origin/destination) in conventional form or for the simwrapper — deriveODMatrix","text":"tripsTable table output trips(readTripsTable) path trips_output file shapePath full path shapefile (simwrapper TRUE, folder shapeFile contain also .dbf name) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation dump.output.path folder save csv file ODMatrix simwrapper create output simwrapper form set path shapefile colnames specific shapefile contains known columns, specified name columns OD. given get numeric values outer logical represent table contain outside flow shape, ","code":""},{"path":"https://vsp.berlin/matsim-r/reference/deriveODMatrix.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates an instance of ODMatrix(origin/destination) in conventional form or for the simwrapper — deriveODMatrix","text":"tibble origin/destination matrix","code":""},{"path":"https://vsp.berlin/matsim-r/reference/filterByRegion.html","id":null,"dir":"Reference","previous_headings":"","what":"Filtering of trips_table(from readTripsTable) depending on how they located in given shape — filterByRegion","title":"Filtering of trips_table(from readTripsTable) depending on how they located in given shape — filterByRegion","text":"Takes trips_table shapeTable(sf object file representing geographical data, can received using function st_read(path_to_file). Please aware filterByRegion currently works, one geometry loaded.) transforms objects match mutual CRS(network.xml MATSimOutputDirectory) filters trips table depending *.inshape flags: start.inshape = TRUE & end.inshape = TRUE return table contains trips inside given shape start.inshape = TRUE & end.inshape = FALSE return table contains trips starts shape ends shape start.inshape = FALSE & end.inshape = TRUE return table contains trips ends shape starts shape start.inshape = FALSE & end.inshape = FALSE return table contains trips starts ends given shape","code":""},{"path":"https://vsp.berlin/matsim-r/reference/filterByRegion.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filtering of trips_table(from readTripsTable) depending on how they located in given shape — filterByRegion","text":"","code":"filterByRegion( tripsTable, shapeTable, crs, start.inshape = TRUE, end.inshape = TRUE )"},{"path":"https://vsp.berlin/matsim-r/reference/filterByRegion.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filtering of trips_table(from readTripsTable) depending on how they located in given shape — filterByRegion","text":"tripsTable tibble trips_output (readTripsTable()) shapeTable sf object(data.frame geometries), can received using st_read(path_to_geographical_file) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation start.inshape bool, defines trips conclude (see Description) end.inshape bool, defines trips conclude (see Description)","code":""},{"path":"https://vsp.berlin/matsim-r/reference/filterByRegion.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filtering of trips_table(from readTripsTable) depending on how they located in given shape — filterByRegion","text":"tibble, filtered trips depending shapeTable special flags (see Description)","code":""},{"path":"https://vsp.berlin/matsim-r/reference/generateXYHexagonYaml.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates/adds XY hexagon definition of output trips to a summary dashboard — generateXYHexagonYaml","title":"Creates/adds XY hexagon definition of output trips to a summary dashboard — generateXYHexagonYaml","text":"Creates/adds XY hexagon definition output trips summary dashboard","code":""},{"path":"https://vsp.berlin/matsim-r/reference/generateXYHexagonYaml.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates/adds XY hexagon definition of output trips to a summary dashboard — generateXYHexagonYaml","text":"","code":"generateXYHexagonYaml( pathToOutputTrips, crs, dump.output.to = matsimDumpOutputDirectory )"},{"path":"https://vsp.berlin/matsim-r/reference/generateXYHexagonYaml.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates/adds XY hexagon definition of output trips to a summary dashboard — generateXYHexagonYaml","text":"pathToOutputTrips specifies path data source output_trips crs specifies coordinate reference system output_trips dump.output.path folder dashboard","code":""},{"path":"https://vsp.berlin/matsim-r/reference/generateXYHexagonYaml.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates/adds XY hexagon definition of output trips to a summary dashboard — generateXYHexagonYaml","text":"changed file","code":""},{"path":"https://vsp.berlin/matsim-r/reference/generate_html_docs.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate html docs from roxygen2 docs — generate_html_docs","title":"Generate html docs from roxygen2 docs — generate_html_docs","text":"https://stackoverflow.com/questions/30897301/export-r-package-documentation---web-page","code":""},{"path":"https://vsp.berlin/matsim-r/reference/generate_html_docs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate html docs from roxygen2 docs — generate_html_docs","text":"","code":"generate_html_docs(pkg, links = tools::findHTMLlinks())"},{"path":"https://vsp.berlin/matsim-r/reference/generate_html_docs.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Generate html docs from roxygen2 docs — generate_html_docs","text":"exported, internal use ","code":""},{"path":"https://vsp.berlin/matsim-r/reference/getCrsFromConfig.html","id":null,"dir":"Reference","previous_headings":"","what":"Reads an coordinate referenec system of MATSim output directory\nfrom output_config.xml — getCrsFromConfig","title":"Reads an coordinate referenec system of MATSim output directory\nfrom output_config.xml — getCrsFromConfig","text":"Reads coordinate referenec system MATSim output directory output_config.xml","code":""},{"path":"https://vsp.berlin/matsim-r/reference/getCrsFromConfig.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reads an coordinate referenec system of MATSim output directory\nfrom output_config.xml — getCrsFromConfig","text":"","code":"getCrsFromConfig(folder)"},{"path":"https://vsp.berlin/matsim-r/reference/getCrsFromConfig.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reads an coordinate referenec system of MATSim output directory\nfrom output_config.xml — getCrsFromConfig","text":"folder specifies path find config","code":""},{"path":"https://vsp.berlin/matsim-r/reference/getCrsFromConfig.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reads an coordinate referenec system of MATSim output directory\nfrom output_config.xml — getCrsFromConfig","text":"code coordinate reference system","code":""},{"path":"https://vsp.berlin/matsim-r/reference/loadNetwork.html","id":null,"dir":"Reference","previous_headings":"","what":"Load MATSim network into memory — loadNetwork","title":"Load MATSim network into memory — loadNetwork","text":"Loads MATSim XML network file, creating nodes tibble links tibble. node link attribute records network stored additional columns respective node link tibbles.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/loadNetwork.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Load MATSim network into memory — loadNetwork","text":"","code":"loadNetwork(filename)"},{"path":"https://vsp.berlin/matsim-r/reference/loadNetwork.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Load MATSim network into memory — loadNetwork","text":"filename File load. Can XML gzipped XML","code":""},{"path":"https://vsp.berlin/matsim-r/reference/loadNetwork.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Load MATSim network into memory — loadNetwork","text":"\"nodes\" \"links\" tibbles list object.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/loadNetwork.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Load MATSim network into memory — loadNetwork","text":"links table automatically joined nodes table node x/y coordinates (node attributes) available links table without additional processing.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotAverageTravelWait.html","id":null,"dir":"Reference","previous_headings":"","what":"Bar Chart with main_mode on x-axis and average travel/wait time on y-axis — plotAverageTravelWait","title":"Bar Chart with main_mode on x-axis and average travel/wait time on y-axis — plotAverageTravelWait","text":"Takes Table trips_output (readTripsTable()), plot bar chart values represent time spent traveling/waiting Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotAverageTravelWait.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Bar Chart with main_mode on x-axis and average travel/wait time on y-axis — plotAverageTravelWait","text":"","code":"plotAverageTravelWait( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotAverageTravelWait.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bar Chart with main_mode on x-axis and average travel/wait time on y-axis — plotAverageTravelWait","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotAverageTravelWait.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Bar Chart with main_mode on x-axis and average travel/wait time on y-axis — plotAverageTravelWait","text":"Bar Chart plot average time spent travel/wait","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotDistanceTraveledByType.html","id":null,"dir":"Reference","previous_headings":"","what":"Bar Chart with tripType on x-axis and travelled distance on y-axis — plotDistanceTraveledByType","title":"Bar Chart with tripType on x-axis and travelled distance on y-axis — plotDistanceTraveledByType","text":"Takes Table trips_output (readTripsTable()), plot bar chart values represent travelled distance tripType related shapeTable","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotDistanceTraveledByType.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Bar Chart with tripType on x-axis and travelled distance on y-axis — plotDistanceTraveledByType","text":"","code":"plotDistanceTraveledByType( tripsTable, shapeTable, crs, dump.output.to = matsimDumpOutputDirectory )"},{"path":"https://vsp.berlin/matsim-r/reference/plotDistanceTraveledByType.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bar Chart with tripType on x-axis and travelled distance on y-axis — plotDistanceTraveledByType","text":"tripsTable tible trips_output (readTripsTable()) shapeTable sf object(data.frame geometries), can received using st_read(path_to_geographical_file) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotDistanceTraveledByType.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Bar Chart with tripType on x-axis and travelled distance on y-axis — plotDistanceTraveledByType","text":"Bar Chart plot average time spent travel/wait","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotEndActCountByArrTime.html","id":null,"dir":"Reference","previous_headings":"","what":"Scatter plot with arrival time x-axis and number end activities on y-axis — plotEndActCountByArrTime","title":"Scatter plot with arrival time x-axis and number end activities on y-axis — plotEndActCountByArrTime","text":"Takes Table trips_output (readTripsTable()), plot scatter plot values represent count end activities specific arrival time Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotEndActCountByArrTime.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Scatter plot with arrival time x-axis and number end activities on y-axis — plotEndActCountByArrTime","text":"","code":"plotEndActCountByArrTime( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotEndActCountByArrTime.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Scatter plot with arrival time x-axis and number end activities on y-axis — plotEndActCountByArrTime","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotEndActCountByArrTime.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Scatter plot with arrival time x-axis and number end activities on y-axis — plotEndActCountByArrTime","text":"Bar Chart plot distance traveled per mode","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTrips.html","id":null,"dir":"Reference","previous_headings":"","what":"Plots result of filtered trips on the map (from shape) — plotMapWithTrips","title":"Plots result of filtered trips on the map (from shape) — plotMapWithTrips","text":"Takes trips_table shapeTable(sf object file representing geographical data, can received using function st_read(path_to_file)) transforms objects match mutual CRS(network.xml MATSimOutputDirectory) filters trips table depending *.inshape flags: start.inshape = TRUE & end.inshape = TRUE return table contains trips inside given shape start.inshape = TRUE & end.inshape = FALSE return table contains trips starts shape ends shape start.inshape = FALSE & end.inshape = TRUE return table contains trips ends shape starts shape start.inshape = FALSE & end.inshape = FALSE return table contains trips starts ends given shape result filtering plotted map shapeTable green points startpoints trip red points endpoints trip","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTrips.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plots result of filtered trips on the map (from shape) — plotMapWithTrips","text":"","code":"plotMapWithTrips( table, shapeTable, crs, start.inshape = TRUE, end.inshape = TRUE, optimized = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTrips.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plots result of filtered trips on the map (from shape) — plotMapWithTrips","text":"table tibble trips_output (readTripsTable()) shapeTable sf object(data.frame geometries), can received using st_read(path_to_geographical_file) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation start.inshape bool, defines trips conclude (see Description) end.inshape bool, defines trips conclude (see Description) optimized bool, default FALSE gives interactive plot using leaflet, TRUE using image ggplot","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTrips.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plots result of filtered trips on the map (from shape) — plotMapWithTrips","text":"plot trips filtered depending flags *.inshape map shapeTable","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTripsType.html","id":null,"dir":"Reference","previous_headings":"","what":"Plots every type of trips(inside, outside, origin and destinating) on map — plotMapWithTripsType","title":"Plots every type of trips(inside, outside, origin and destinating) on map — plotMapWithTripsType","text":"Plots every type trips(inside, outside, origin destinating) map","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTripsType.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plots every type of trips(inside, outside, origin and destinating) on map — plotMapWithTripsType","text":"","code":"plotMapWithTripsType(table, shapeTable, crs, optimized = FALSE)"},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTripsType.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plots every type of trips(inside, outside, origin and destinating) on map — plotMapWithTripsType","text":"table tibble trips_output (readTripsTable()) shapeTable sf object(data.frame geometries), can received using st_read(path_to_geographical_file) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation optimized bool, default FALSE gives interactive plot using leaflet, TRUE using image ggplot","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTripsType.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plots every type of trips(inside, outside, origin and destinating) on map — plotMapWithTripsType","text":"plot contains every trip defined trip type","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftBar.html","id":null,"dir":"Reference","previous_headings":"","what":"Plot bar chart diagram of transport mode changes — plotModalShiftBar","title":"Plot bar chart diagram of transport mode changes — plotModalShiftBar","text":"Takes two trips_table (readTripsTable), collects changes transport mode distribution tables make bar chart diagram dodging positioning data","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftBar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plot bar chart diagram of transport mode changes — plotModalShiftBar","text":"","code":"plotModalShiftBar( tripsTable1, tripsTable2, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, output.name = \"modalShiftBarChart\" )"},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftBar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plot bar chart diagram of transport mode changes — plotModalShiftBar","text":"tripsTable1 tible trips_output (readTripsTable()) tripsTable2 tible trips_output (readTripsTable()) unite.columns vector character string, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name columns united, can specify name resulting column plot dump.output.folder saves configures yaml simwrapper. folder png plot stored","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftBar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plot bar chart diagram of transport mode changes — plotModalShiftBar","text":"Alluvial diagram represents changes transport mode distribution trip tables","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftBar.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Plot bar chart diagram of transport mode changes — plotModalShiftBar","text":"Function calculates number transport mode used first second table, draws plot represent distribution transport mode changed (f. e. part concrete trasport mode changed another) Using parameter unite.columns transport modes match PATTERN unite.columns can united 1 transport mode type (default united.name \"united\") Using parameter show.onlyChanges","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftSankey.html","id":null,"dir":"Reference","previous_headings":"","what":"Plot alluvial/sankey diagram of transport mode changes — plotModalShiftSankey","title":"Plot alluvial/sankey diagram of transport mode changes — plotModalShiftSankey","text":"Takes two trips_table (readTripsTable), collects changes transport mode distribution tables make alluvial diagram data","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftSankey.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plot alluvial/sankey diagram of transport mode changes — plotModalShiftSankey","text":"","code":"plotModalShiftSankey( tripsTable1, tripsTable2, show.onlyChanges = FALSE, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory )"},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftSankey.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plot alluvial/sankey diagram of transport mode changes — plotModalShiftSankey","text":"tripsTable1 tible trips_output (readTripsTable()) tripsTable2 tible trips_output (readTripsTable()) show.onlyChanges boolean, set TRUE => sankey diagram contains changes axes unite.columns vector character string, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name columns united, can specify name resulting column plot dump.output.folder saves configures yaml simwrapper. folder png plot stored","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftSankey.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plot alluvial/sankey diagram of transport mode changes — plotModalShiftSankey","text":"Alluvial diagram represents changes transport mode distribution trip tables","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftSankey.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Plot alluvial/sankey diagram of transport mode changes — plotModalShiftSankey","text":"Function calculates number transport mode used first second table, draws plot represent distribution transport mode changed (f. e. part concrete trasport mode changed another) Using parameter unite.columns transport modes match PATTERN unite.columns can united 1 transport mode type (default united.name \"united\") Using parameter show.onlyChanges","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitBarChart.html","id":null,"dir":"Reference","previous_headings":"","what":"Plot main_mode as a bar Chart — plotModalSplitBarChart","title":"Plot main_mode as a bar Chart — plotModalSplitBarChart","text":"Takes Table trips_output (readTripsTable()), plot bar chart values represent percentage using transport modes trips","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitBarChart.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plot main_mode as a bar Chart — plotModalSplitBarChart","text":"","code":"plotModalSplitBarChart( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitBarChart.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plot main_mode as a bar Chart — plotModalSplitBarChart","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitBarChart.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plot main_mode as a bar Chart — plotModalSplitBarChart","text":"Bar Chart plot transport mode distribution, values given percents","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitBarChart.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Plot main_mode as a bar Chart — plotModalSplitBarChart","text":"Function automatically detects transport_modes table plots pie chart percentage distribution. Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitPieChart.html","id":null,"dir":"Reference","previous_headings":"","what":"Plot main_mode as a Pie Chart — plotModalSplitPieChart","title":"Plot main_mode as a Pie Chart — plotModalSplitPieChart","text":"Takes Table trips_output (readTripsTable()), plot pie chart values represent percentage using transport modes trips","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitPieChart.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plot main_mode as a Pie Chart — plotModalSplitPieChart","text":"","code":"plotModalSplitPieChart( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitPieChart.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plot main_mode as a Pie Chart — plotModalSplitPieChart","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitPieChart.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plot main_mode as a Pie Chart — plotModalSplitPieChart","text":"Pie Chart plot transport mode distribution, values given percents","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitPieChart.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Plot main_mode as a Pie Chart — plotModalSplitPieChart","text":"Function automatically detects transport_modes table plots pie chart. Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotStartActCountByDepTime.html","id":null,"dir":"Reference","previous_headings":"","what":"Scatter plot with departure time x-axis and number start activities on y-axis — plotStartActCountByDepTime","title":"Scatter plot with departure time x-axis and number start activities on y-axis — plotStartActCountByDepTime","text":"Takes Table trips_output (readTripsTable()), plot scatter plot values represent count start activities specific departure time main_mode Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotStartActCountByDepTime.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Scatter plot with departure time x-axis and number start activities on y-axis — plotStartActCountByDepTime","text":"","code":"plotStartActCountByDepTime( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotStartActCountByDepTime.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Scatter plot with departure time x-axis and number start activities on y-axis — plotStartActCountByDepTime","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotStartActCountByDepTime.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Scatter plot with departure time x-axis and number start activities on y-axis — plotStartActCountByDepTime","text":"Bar Chart plot distance traveled per mode","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripCountByDepTime.html","id":null,"dir":"Reference","previous_headings":"","what":"Scatter plot with departure time x-axis and number of trips on y-axis — plotTripCountByDepTime","title":"Scatter plot with departure time x-axis and number of trips on y-axis — plotTripCountByDepTime","text":"Takes Table trips_output (readTripsTable()), plot scatter plot values represent count trips specific departure time main_mode Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripCountByDepTime.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Scatter plot with departure time x-axis and number of trips on y-axis — plotTripCountByDepTime","text":"","code":"plotTripCountByDepTime( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotTripCountByDepTime.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Scatter plot with departure time x-axis and number of trips on y-axis — plotTripCountByDepTime","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripCountByDepTime.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Scatter plot with departure time x-axis and number of trips on y-axis — plotTripCountByDepTime","text":"Bar Chart plot distance traveled per mode","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripDistanceByMode.html","id":null,"dir":"Reference","previous_headings":"","what":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripDistanceByMode","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripDistanceByMode","text":"Takes Table trips_output (readTripsTable()), plot bar chart values represent average distance traveled ~ main mode used Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripDistanceByMode.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripDistanceByMode","text":"","code":"plotTripDistanceByMode( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotTripDistanceByMode.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripDistanceByMode","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripDistanceByMode.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripDistanceByMode","text":"Bar Chart plot distance traveled per mode","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripTypesPieChart.html","id":null,"dir":"Reference","previous_headings":"","what":"Plots distribution of every type of trips(inside, outside, origin and destinating) in Pie Chart — plotTripTypesPieChart","title":"Plots distribution of every type of trips(inside, outside, origin and destinating) in Pie Chart — plotTripTypesPieChart","text":"Plots distribution every type trips(inside, outside, origin destinating) Pie Chart","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripTypesPieChart.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plots distribution of every type of trips(inside, outside, origin and destinating) in Pie Chart — plotTripTypesPieChart","text":"","code":"plotTripTypesPieChart(table, shapeTable, crs)"},{"path":"https://vsp.berlin/matsim-r/reference/plotTripTypesPieChart.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plots distribution of every type of trips(inside, outside, origin and destinating) in Pie Chart — plotTripTypesPieChart","text":"table tibble trips_output (readTripsTable()) shapeTable sf object(data.frame geometries), can received using st_read(path_to_geographical_file) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripTypesPieChart.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plots distribution of every type of trips(inside, outside, origin and destinating) in Pie Chart — plotTripTypesPieChart","text":"plot percentage type trips","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripsByDistance.html","id":null,"dir":"Reference","previous_headings":"","what":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripsByDistance","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripsByDistance","text":"Takes Table trips_output (readTripsTable()), plot bar chart values represent number trips ~ distance travelled Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripsByDistance.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripsByDistance","text":"","code":"plotTripsByDistance( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotTripsByDistance.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripsByDistance","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripsByDistance.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripsByDistance","text":"Bar Chart plot count trips among distance travelled","code":""},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromFolder.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromFolder","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromFolder","text":"Creates dashboard given table folder data","code":""},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromFolder.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromFolder","text":"","code":"prepareSimwrapperDashboardFromFolder( folder = \"./\", dump.output.to = matsimDumpOutputDirectory, append = TRUE )"},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromFolder.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromFolder","text":"folder specifies data source folder tripsOutput dump.output.folder saves configures yaml simwrapper dashboard plots append specifies output folder erased creating","code":""},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromFolder.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromFolder","text":"tibble output_trips folder. Generates content needed Simwrapper","code":""},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromTable.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromTable","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromTable","text":"Creates dashboard given table folder data","code":""},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromTable.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromTable","text":"","code":"prepareSimwrapperDashboardFromTable( table, dump.output.to = matsimDumpOutputDirectory, append = TRUE )"},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromTable.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromTable","text":"table trips_output tibble readTripsTable() dump.output.folder saves configures yaml simwrapper dashboard plots using functions: plotModalSplitBarChart(),plotModalSplitPieChart(),plotModalShift(). append specifies output folder erased creating","code":""},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromTable.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromTable","text":"generates folder content simwrapper trips table","code":""},{"path":"https://vsp.berlin/matsim-r/reference/readTripsTable.html","id":null,"dir":"Reference","previous_headings":"","what":"Load MATSIM output_trips table into Memory — readTripsTable","title":"Load MATSIM output_trips table into Memory — readTripsTable","text":"Loads MATSim CSV output_trips file archive, creating tibble columns csv file","code":""},{"path":"https://vsp.berlin/matsim-r/reference/readTripsTable.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Load MATSIM output_trips table into Memory — readTripsTable","text":"","code":"readTripsTable(pathToMATSimOutputDirectory = \".\")"},{"path":"https://vsp.berlin/matsim-r/reference/readTripsTable.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Load MATSIM output_trips table into Memory — readTripsTable","text":"pathToMATSimOutputDirectory character string, path matsim output directory http link file.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/readTripsTable.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Load MATSIM output_trips table into Memory — readTripsTable","text":"tibble trips_output","code":""},{"path":"https://vsp.berlin/matsim-r/reference/transformToSf.html","id":null,"dir":"Reference","previous_headings":"","what":"Transforms trips_table tibble (from readTripsTable) from tibble to sf (table with attribute features and geometry feature) — transformToSf","title":"Transforms trips_table tibble (from readTripsTable) from tibble to sf (table with attribute features and geometry feature) — transformToSf","text":"Takes trips_table (readTripsTable) transforms trips_table sf object using start_x, end_x, start_y, end_y geometry features deletes resulting data.frame start_x, end_x, start_y, end_y. adds wkt column, geometry.type = st_mulitpoint(), geometry.type = st_linestring() adds start_wkt end_wkt, geometry.type = st_point() Added column/columns projected given CRS (coordinate reference system), can taken network file MATSimOutputDirectory","code":""},{"path":"https://vsp.berlin/matsim-r/reference/transformToSf.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Transforms trips_table tibble (from readTripsTable) from tibble to sf (table with attribute features and geometry feature) — transformToSf","text":"","code":"transformToSf(table, crs, geometry.type = st_multipoint())"},{"path":"https://vsp.berlin/matsim-r/reference/transformToSf.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Transforms trips_table tibble (from readTripsTable) from tibble to sf (table with attribute features and geometry feature) — transformToSf","text":"table tibble trips_output (readTripsTable()) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation geometry.type function sf transformation, geometry.type can (default st_multipoint()) !!!st_point()-resulting table contains 2 geometries start_wkt end_wkt, representing start end POINTs, type POINT!!! !!!st_multipoint()-resulting table contains 1 geometry wkt, representing start end POINTS MULTIPOINT!!! !!!st_linestring() - resulting table contains 1 geometry wkt, representing line start end points LINESTRING!!!","code":""},{"path":"https://vsp.berlin/matsim-r/reference/transformToSf.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Transforms trips_table tibble (from readTripsTable) from tibble to sf (table with attribute features and geometry feature) — transformToSf","text":"sf object (data.frame geometries depending geometry.type)","code":""},{"path":"https://vsp.berlin/matsim-r/reference/transformToSf.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Transforms trips_table tibble (from readTripsTable) from tibble to sf (table with attribute features and geometry feature) — transformToSf","text":"Function also sets attribute geometry.type resulting table character value \"POINT\",\"MULTIPOINT\",\"LINESTRING\" get type table generated, needed","code":""}] +[{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"GNU General Public License","title":"GNU General Public License","text":"Version 3, 29 June 2007Copyright © 2007 Free Software Foundation, Inc. Everyone permitted copy distribute verbatim copies license document, changing allowed.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"preamble","dir":"","previous_headings":"","what":"Preamble","title":"GNU General Public License","text":"GNU General Public License free, copyleft license software kinds works. licenses software practical works designed take away freedom share change works. contrast, GNU General Public License intended guarantee freedom share change versions program–make sure remains free software users. , Free Software Foundation, use GNU General Public License software; applies also work released way authors. can apply programs, . speak free software, referring freedom, price. General Public Licenses designed make sure freedom distribute copies free software (charge wish), receive source code can get want , can change software use pieces new free programs, know can things. protect rights, need prevent others denying rights asking surrender rights. Therefore, certain responsibilities distribute copies software, modify : responsibilities respect freedom others. example, distribute copies program, whether gratis fee, must pass recipients freedoms received. must make sure , , receive can get source code. must show terms know rights. Developers use GNU GPL protect rights two steps: (1) assert copyright software, (2) offer License giving legal permission copy, distribute /modify . developers’ authors’ protection, GPL clearly explains warranty free software. users’ authors’ sake, GPL requires modified versions marked changed, problems attributed erroneously authors previous versions. devices designed deny users access install run modified versions software inside , although manufacturer can . fundamentally incompatible aim protecting users’ freedom change software. systematic pattern abuse occurs area products individuals use, precisely unacceptable. Therefore, designed version GPL prohibit practice products. problems arise substantially domains, stand ready extend provision domains future versions GPL, needed protect freedom users. Finally, every program threatened constantly software patents. States allow patents restrict development use software general-purpose computers, , wish avoid special danger patents applied free program make effectively proprietary. prevent , GPL assures patents used render program non-free. precise terms conditions copying, distribution modification follow.","code":""},{"path":[]},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_0-definitions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"0. Definitions","title":"GNU General Public License","text":"“License” refers version 3 GNU General Public License. “Copyright” also means copyright-like laws apply kinds works, semiconductor masks. “Program” refers copyrightable work licensed License. licensee addressed “”. “Licensees” “recipients” may individuals organizations. “modify” work means copy adapt part work fashion requiring copyright permission, making exact copy. resulting work called “modified version” earlier work work “based ” earlier work. “covered work” means either unmodified Program work based Program. “propagate” work means anything , without permission, make directly secondarily liable infringement applicable copyright law, except executing computer modifying private copy. Propagation includes copying, distribution (without modification), making available public, countries activities well. “convey” work means kind propagation enables parties make receive copies. Mere interaction user computer network, transfer copy, conveying. interactive user interface displays “Appropriate Legal Notices” extent includes convenient prominently visible feature (1) displays appropriate copyright notice, (2) tells user warranty work (except extent warranties provided), licensees may convey work License, view copy License. interface presents list user commands options, menu, prominent item list meets criterion.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_1-source-code","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"1. Source Code","title":"GNU General Public License","text":"“source code” work means preferred form work making modifications . “Object code” means non-source form work. “Standard Interface” means interface either official standard defined recognized standards body, , case interfaces specified particular programming language, one widely used among developers working language. “System Libraries” executable work include anything, work whole, () included normal form packaging Major Component, part Major Component, (b) serves enable use work Major Component, implement Standard Interface implementation available public source code form. “Major Component”, context, means major essential component (kernel, window system, ) specific operating system () executable work runs, compiler used produce work, object code interpreter used run . “Corresponding Source” work object code form means source code needed generate, install, (executable work) run object code modify work, including scripts control activities. However, include work’s System Libraries, general-purpose tools generally available free programs used unmodified performing activities part work. example, Corresponding Source includes interface definition files associated source files work, source code shared libraries dynamically linked subprograms work specifically designed require, intimate data communication control flow subprograms parts work. Corresponding Source need include anything users can regenerate automatically parts Corresponding Source. Corresponding Source work source code form work.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_2-basic-permissions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"2. Basic Permissions","title":"GNU General Public License","text":"rights granted License granted term copyright Program, irrevocable provided stated conditions met. License explicitly affirms unlimited permission run unmodified Program. output running covered work covered License output, given content, constitutes covered work. License acknowledges rights fair use equivalent, provided copyright law. may make, run propagate covered works convey, without conditions long license otherwise remains force. may convey covered works others sole purpose make modifications exclusively , provide facilities running works, provided comply terms License conveying material control copyright. thus making running covered works must exclusively behalf, direction control, terms prohibit making copies copyrighted material outside relationship . Conveying circumstances permitted solely conditions stated . Sublicensing allowed; section 10 makes unnecessary.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_3-protecting-users-legal-rights-from-anti-circumvention-law","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"3. Protecting Users’ Legal Rights From Anti-Circumvention Law","title":"GNU General Public License","text":"covered work shall deemed part effective technological measure applicable law fulfilling obligations article 11 WIPO copyright treaty adopted 20 December 1996, similar laws prohibiting restricting circumvention measures. convey covered work, waive legal power forbid circumvention technological measures extent circumvention effected exercising rights License respect covered work, disclaim intention limit operation modification work means enforcing, work’s users, third parties’ legal rights forbid circumvention technological measures.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_4-conveying-verbatim-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"4. Conveying Verbatim Copies","title":"GNU General Public License","text":"may convey verbatim copies Program’s source code receive , medium, provided conspicuously appropriately publish copy appropriate copyright notice; keep intact notices stating License non-permissive terms added accord section 7 apply code; keep intact notices absence warranty; give recipients copy License along Program. may charge price price copy convey, may offer support warranty protection fee.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_5-conveying-modified-source-versions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"5. Conveying Modified Source Versions","title":"GNU General Public License","text":"may convey work based Program, modifications produce Program, form source code terms section 4, provided also meet conditions: ) work must carry prominent notices stating modified , giving relevant date. b) work must carry prominent notices stating released License conditions added section 7. requirement modifies requirement section 4 “keep intact notices”. c) must license entire work, whole, License anyone comes possession copy. License therefore apply, along applicable section 7 additional terms, whole work, parts, regardless packaged. License gives permission license work way, invalidate permission separately received . d) work interactive user interfaces, must display Appropriate Legal Notices; however, Program interactive interfaces display Appropriate Legal Notices, work need make . compilation covered work separate independent works, nature extensions covered work, combined form larger program, volume storage distribution medium, called “aggregate” compilation resulting copyright used limit access legal rights compilation’s users beyond individual works permit. Inclusion covered work aggregate cause License apply parts aggregate.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_6-conveying-non-source-forms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"6. Conveying Non-Source Forms","title":"GNU General Public License","text":"may convey covered work object code form terms sections 4 5, provided also convey machine-readable Corresponding Source terms License, one ways: ) Convey object code , embodied , physical product (including physical distribution medium), accompanied Corresponding Source fixed durable physical medium customarily used software interchange. b) Convey object code , embodied , physical product (including physical distribution medium), accompanied written offer, valid least three years valid long offer spare parts customer support product model, give anyone possesses object code either (1) copy Corresponding Source software product covered License, durable physical medium customarily used software interchange, price reasonable cost physically performing conveying source, (2) access copy Corresponding Source network server charge. c) Convey individual copies object code copy written offer provide Corresponding Source. alternative allowed occasionally noncommercially, received object code offer, accord subsection 6b. d) Convey object code offering access designated place (gratis charge), offer equivalent access Corresponding Source way place charge. need require recipients copy Corresponding Source along object code. place copy object code network server, Corresponding Source may different server (operated third party) supports equivalent copying facilities, provided maintain clear directions next object code saying find Corresponding Source. Regardless server hosts Corresponding Source, remain obligated ensure available long needed satisfy requirements. e) Convey object code using peer--peer transmission, provided inform peers object code Corresponding Source work offered general public charge subsection 6d. separable portion object code, whose source code excluded Corresponding Source System Library, need included conveying object code work. “User Product” either (1) “consumer product”, means tangible personal property normally used personal, family, household purposes, (2) anything designed sold incorporation dwelling. determining whether product consumer product, doubtful cases shall resolved favor coverage. particular product received particular user, “normally used” refers typical common use class product, regardless status particular user way particular user actually uses, expects expected use, product. product consumer product regardless whether product substantial commercial, industrial non-consumer uses, unless uses represent significant mode use product. “Installation Information” User Product means methods, procedures, authorization keys, information required install execute modified versions covered work User Product modified version Corresponding Source. information must suffice ensure continued functioning modified object code case prevented interfered solely modification made. convey object code work section , , specifically use , User Product, conveying occurs part transaction right possession use User Product transferred recipient perpetuity fixed term (regardless transaction characterized), Corresponding Source conveyed section must accompanied Installation Information. requirement apply neither third party retains ability install modified object code User Product (example, work installed ROM). requirement provide Installation Information include requirement continue provide support service, warranty, updates work modified installed recipient, User Product modified installed. Access network may denied modification materially adversely affects operation network violates rules protocols communication across network. Corresponding Source conveyed, Installation Information provided, accord section must format publicly documented (implementation available public source code form), must require special password key unpacking, reading copying.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_7-additional-terms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"7. Additional Terms","title":"GNU General Public License","text":"“Additional permissions” terms supplement terms License making exceptions one conditions. Additional permissions applicable entire Program shall treated though included License, extent valid applicable law. additional permissions apply part Program, part may used separately permissions, entire Program remains governed License without regard additional permissions. convey copy covered work, may option remove additional permissions copy, part . (Additional permissions may written require removal certain cases modify work.) may place additional permissions material, added covered work, can give appropriate copyright permission. Notwithstanding provision License, material add covered work, may (authorized copyright holders material) supplement terms License terms: ) Disclaiming warranty limiting liability differently terms sections 15 16 License; b) Requiring preservation specified reasonable legal notices author attributions material Appropriate Legal Notices displayed works containing ; c) Prohibiting misrepresentation origin material, requiring modified versions material marked reasonable ways different original version; d) Limiting use publicity purposes names licensors authors material; e) Declining grant rights trademark law use trade names, trademarks, service marks; f) Requiring indemnification licensors authors material anyone conveys material (modified versions ) contractual assumptions liability recipient, liability contractual assumptions directly impose licensors authors. non-permissive additional terms considered “restrictions” within meaning section 10. Program received , part , contains notice stating governed License along term restriction, may remove term. license document contains restriction permits relicensing conveying License, may add covered work material governed terms license document, provided restriction survive relicensing conveying. add terms covered work accord section, must place, relevant source files, statement additional terms apply files, notice indicating find applicable terms. Additional terms, permissive non-permissive, may stated form separately written license, stated exceptions; requirements apply either way.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_8-termination","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"8. Termination","title":"GNU General Public License","text":"may propagate modify covered work except expressly provided License. attempt otherwise propagate modify void, automatically terminate rights License (including patent licenses granted third paragraph section 11). However, cease violation License, license particular copyright holder reinstated () provisionally, unless copyright holder explicitly finally terminates license, (b) permanently, copyright holder fails notify violation reasonable means prior 60 days cessation. Moreover, license particular copyright holder reinstated permanently copyright holder notifies violation reasonable means, first time received notice violation License (work) copyright holder, cure violation prior 30 days receipt notice. Termination rights section terminate licenses parties received copies rights License. rights terminated permanently reinstated, qualify receive new licenses material section 10.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_9-acceptance-not-required-for-having-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"9. Acceptance Not Required for Having Copies","title":"GNU General Public License","text":"required accept License order receive run copy Program. Ancillary propagation covered work occurring solely consequence using peer--peer transmission receive copy likewise require acceptance. However, nothing License grants permission propagate modify covered work. actions infringe copyright accept License. Therefore, modifying propagating covered work, indicate acceptance License .","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_10-automatic-licensing-of-downstream-recipients","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"10. Automatic Licensing of Downstream Recipients","title":"GNU General Public License","text":"time convey covered work, recipient automatically receives license original licensors, run, modify propagate work, subject License. responsible enforcing compliance third parties License. “entity transaction” transaction transferring control organization, substantially assets one, subdividing organization, merging organizations. propagation covered work results entity transaction, party transaction receives copy work also receives whatever licenses work party’s predecessor interest give previous paragraph, plus right possession Corresponding Source work predecessor interest, predecessor can get reasonable efforts. may impose restrictions exercise rights granted affirmed License. example, may impose license fee, royalty, charge exercise rights granted License, may initiate litigation (including cross-claim counterclaim lawsuit) alleging patent claim infringed making, using, selling, offering sale, importing Program portion .","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_11-patents","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"11. Patents","title":"GNU General Public License","text":"“contributor” copyright holder authorizes use License Program work Program based. work thus licensed called contributor’s “contributor version”. contributor’s “essential patent claims” patent claims owned controlled contributor, whether already acquired hereafter acquired, infringed manner, permitted License, making, using, selling contributor version, include claims infringed consequence modification contributor version. purposes definition, “control” includes right grant patent sublicenses manner consistent requirements License. contributor grants non-exclusive, worldwide, royalty-free patent license contributor’s essential patent claims, make, use, sell, offer sale, import otherwise run, modify propagate contents contributor version. following three paragraphs, “patent license” express agreement commitment, however denominated, enforce patent (express permission practice patent covenant sue patent infringement). “grant” patent license party means make agreement commitment enforce patent party. convey covered work, knowingly relying patent license, Corresponding Source work available anyone copy, free charge terms License, publicly available network server readily accessible means, must either (1) cause Corresponding Source available, (2) arrange deprive benefit patent license particular work, (3) arrange, manner consistent requirements License, extend patent license downstream recipients. “Knowingly relying” means actual knowledge , patent license, conveying covered work country, recipient’s use covered work country, infringe one identifiable patents country reason believe valid. , pursuant connection single transaction arrangement, convey, propagate procuring conveyance , covered work, grant patent license parties receiving covered work authorizing use, propagate, modify convey specific copy covered work, patent license grant automatically extended recipients covered work works based . patent license “discriminatory” include within scope coverage, prohibits exercise , conditioned non-exercise one rights specifically granted License. may convey covered work party arrangement third party business distributing software, make payment third party based extent activity conveying work, third party grants, parties receive covered work , discriminatory patent license () connection copies covered work conveyed (copies made copies), (b) primarily connection specific products compilations contain covered work, unless entered arrangement, patent license granted, prior 28 March 2007. Nothing License shall construed excluding limiting implied license defenses infringement may otherwise available applicable patent law.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_12-no-surrender-of-others-freedom","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"12. No Surrender of Others’ Freedom","title":"GNU General Public License","text":"conditions imposed (whether court order, agreement otherwise) contradict conditions License, excuse conditions License. convey covered work satisfy simultaneously obligations License pertinent obligations, consequence may convey . example, agree terms obligate collect royalty conveying convey Program, way satisfy terms License refrain entirely conveying Program.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_13-use-with-the-gnu-affero-general-public-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"13. Use with the GNU Affero General Public License","title":"GNU General Public License","text":"Notwithstanding provision License, permission link combine covered work work licensed version 3 GNU Affero General Public License single combined work, convey resulting work. terms License continue apply part covered work, special requirements GNU Affero General Public License, section 13, concerning interaction network apply combination .","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_14-revised-versions-of-this-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"14. Revised Versions of this License","title":"GNU General Public License","text":"Free Software Foundation may publish revised /new versions GNU General Public License time time. new versions similar spirit present version, may differ detail address new problems concerns. version given distinguishing version number. Program specifies certain numbered version GNU General Public License “later version” applies , option following terms conditions either numbered version later version published Free Software Foundation. Program specify version number GNU General Public License, may choose version ever published Free Software Foundation. Program specifies proxy can decide future versions GNU General Public License can used, proxy’s public statement acceptance version permanently authorizes choose version Program. Later license versions may give additional different permissions. However, additional obligations imposed author copyright holder result choosing follow later version.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_15-disclaimer-of-warranty","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"15. Disclaimer of Warranty","title":"GNU General Public License","text":"WARRANTY PROGRAM, EXTENT PERMITTED APPLICABLE LAW. EXCEPT OTHERWISE STATED WRITING COPYRIGHT HOLDERS /PARTIES PROVIDE PROGRAM “” WITHOUT WARRANTY KIND, EITHER EXPRESSED IMPLIED, INCLUDING, LIMITED , IMPLIED WARRANTIES MERCHANTABILITY FITNESS PARTICULAR PURPOSE. ENTIRE RISK QUALITY PERFORMANCE PROGRAM . PROGRAM PROVE DEFECTIVE, ASSUME COST NECESSARY SERVICING, REPAIR CORRECTION.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_16-limitation-of-liability","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"16. Limitation of Liability","title":"GNU General Public License","text":"EVENT UNLESS REQUIRED APPLICABLE LAW AGREED WRITING COPYRIGHT HOLDER, PARTY MODIFIES /CONVEYS PROGRAM PERMITTED , LIABLE DAMAGES, INCLUDING GENERAL, SPECIAL, INCIDENTAL CONSEQUENTIAL DAMAGES ARISING USE INABILITY USE PROGRAM (INCLUDING LIMITED LOSS DATA DATA RENDERED INACCURATE LOSSES SUSTAINED THIRD PARTIES FAILURE PROGRAM OPERATE PROGRAMS), EVEN HOLDER PARTY ADVISED POSSIBILITY DAMAGES.","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"id_17-interpretation-of-sections-15-and-16","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"17. Interpretation of Sections 15 and 16","title":"GNU General Public License","text":"disclaimer warranty limitation liability provided given local legal effect according terms, reviewing courts shall apply local law closely approximates absolute waiver civil liability connection Program, unless warranty assumption liability accompanies copy Program return fee. END TERMS CONDITIONS","code":""},{"path":"https://vsp.berlin/matsim-r/LICENSE.html","id":"how-to-apply-these-terms-to-your-new-programs","dir":"","previous_headings":"","what":"How to Apply These Terms to Your New Programs","title":"GNU General Public License","text":"develop new program, want greatest possible use public, best way achieve make free software everyone can redistribute change terms. , attach following notices program. safest attach start source file effectively state exclusion warranty; file least “copyright” line pointer full notice found. Also add information contact electronic paper mail. program terminal interaction, make output short notice like starts interactive mode: hypothetical commands show w show c show appropriate parts General Public License. course, program’s commands might different; GUI interface, use “box”. also get employer (work programmer) school, , sign “copyright disclaimer” program, necessary. information , apply follow GNU GPL, see . GNU General Public License permit incorporating program proprietary programs. program subroutine library, may consider useful permit linking proprietary applications library. want , use GNU Lesser General Public License instead License. first, please read .","code":" Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free software, and you are welcome to redistribute it under certain conditions; type 'show c' for details."},{"path":"https://vsp.berlin/matsim-r/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Billy Charlton. Author, maintainer. Oleksandr Soboliev. Author.","code":""},{"path":"https://vsp.berlin/matsim-r/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Charlton B, Soboliev O (2022). matsim: R library interfacing MATSim agent-based microsimulation model. R package version 0.1.7, https://github.com/matsim-vsp/matsim-r.","code":"@Manual{, title = {matsim: R library for interfacing with MATSim agent-based microsimulation model}, author = {Billy Charlton and Oleksandr Soboliev}, year = {2022}, note = {R package version 0.1.7}, url = {https://github.com/matsim-vsp/matsim-r}, }"},{"path":"https://vsp.berlin/matsim-r/index.html","id":"matsim-r-support-package","dir":"","previous_headings":"","what":"R library for interfacing with MATSim agent-based microsimulation model","title":"R library for interfacing with MATSim agent-based microsimulation model","text":"MATSim https://matsim.org agent-based microsimulation package large-scape transport simulations. package mimics functionality Python matsim-tools package, eventually support standard MATSim networks, plans events. Currently network files supported, many summarization plots based MATSim standard output_trips file. One useful command builds SimWrapper dashboard standard MATSim output_trips.xml.gz file: R -e \"prepareSimwrapperDashboardFromFolder()\" work preliminary ongoing – submissions welcome!","code":""},{"path":"https://vsp.berlin/matsim-r/index.html","id":"install","dir":"","previous_headings":"","what":"Install","title":"R library for interfacing with MATSim agent-based microsimulation model","text":"can install package right now: install.packages(\"devtools\") devtools::install_github(\"matsim-vsp/matsim-r\") install package specific branch use: devtools::install_github(\"matsim-vsp/matsim-r\",ref=\"{name branch}\")","code":""},{"path":"https://vsp.berlin/matsim-r/index.html","id":"installing-from-gz-archive","dir":"","previous_headings":"Install","what":"Installing from .gz archive","title":"R library for interfacing with MATSim agent-based microsimulation model","text":"Instead using devtools can also install directly source archive: install.packages(\"matsim-r.tar.gz\", type=\"source\", repos=NULL)","code":""},{"path":"https://vsp.berlin/matsim-r/index.html","id":"documentation-build-instructions","dir":"","previous_headings":"","what":"Documentation build instructions","title":"R library for interfacing with MATSim agent-based microsimulation model","text":"Run GNU Make build docs whenever source files R/ change. create man pages well fancy HTML docs/ folder , build : devtools::document() builds docs NAMESPACE pkgdown::build_site() builds HTML docs","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyOutput.html","id":null,"dir":"Reference","previous_headings":"","what":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyOutput","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyOutput","text":"Chooses function compare output_trips folders. baseFolder contains base outputs, policyFolder contains policy outputs.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyOutput.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyOutput","text":"","code":"compareBasePolicyOutput( baseFolder, policyFolder, dump.output.to = matsimDumpOutputDirectory )"},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyOutput.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyOutput","text":"baseFolder specifies data source folder multiple base output_trips policyFolder specifies data source folder multiple policy output_trips dump.output.saves result comparisons base policy. now creates plotModalShiftBar() output_trips","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyOutput.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyOutput","text":"list tibbles, list base policy output_trips tibble","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyShapeOutput.html","id":null,"dir":"Reference","previous_headings":"","what":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyShapeOutput","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyShapeOutput","text":"Chooses function compare output_trips folders. baseFolder contains base outputs, policyFolder contains policy outputs.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyShapeOutput.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyShapeOutput","text":"","code":"compareBasePolicyShapeOutput( baseFolder, policyFolder, shapeFilePath, crs, dump.output.to = matsimDumpOutputDirectory )"},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyShapeOutput.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyShapeOutput","text":"baseFolder specifies data source folder multiple base output_trips policyFolder specifies data source folder multiple policy output_trips shapeFilePath specifies shapeFile used comparison crs numeric EPSG code proj4string, can found network/config file output directory MATSim simulation dump.output.saves result comparisons base policy. now creates plotModalShiftBar() output_trips","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareBasePolicyShapeOutput.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Chooses a function to compare output_trips from the folders.\nbaseFolder contains all base outputs, policyFolder contains all policy outputs. — compareBasePolicyShapeOutput","text":"list tibbles, list base policy output_trips tibble","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareTripTypesBarChart.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates BarChart of changing trip types(originating,transit etc) between 2 tables\nand saves output to dump.output.to — compareTripTypesBarChart","title":"Creates BarChart of changing trip types(originating,transit etc) between 2 tables\nand saves output to dump.output.to — compareTripTypesBarChart","text":"Creates BarChart changing trip types(originating,transit etc) 2 tables saves output dump.output.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareTripTypesBarChart.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates BarChart of changing trip types(originating,transit etc) between 2 tables\nand saves output to dump.output.to — compareTripTypesBarChart","text":"","code":"compareTripTypesBarChart( tripsTable1, tripsTable2, shapeTable, crs, dump.output.to = matsimDumpOutputDirectory )"},{"path":"https://vsp.berlin/matsim-r/reference/compareTripTypesBarChart.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates BarChart of changing trip types(originating,transit etc) between 2 tables\nand saves output to dump.output.to — compareTripTypesBarChart","text":"tripsTable1 tibble trips_output (readTripsTable(),f.e. base case) tripsTable2 tibble trips_output (readTripsTable(),f.e. policy case) shapeTable sf object(data.frame geometries), can received using st_read(path_to_geographical_file) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation dump.output.folder saves resulting image BarChart","code":""},{"path":"https://vsp.berlin/matsim-r/reference/compareTripTypesBarChart.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates BarChart of changing trip types(originating,transit etc) between 2 tables\nand saves output to dump.output.to — compareTripTypesBarChart","text":"plot percentage type trips 2 tables","code":""},{"path":"https://vsp.berlin/matsim-r/reference/deriveODMatrix.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates an instance of ODMatrix(origin/destination) in conventional form or for the simwrapper — deriveODMatrix","title":"Creates an instance of ODMatrix(origin/destination) in conventional form or for the simwrapper — deriveODMatrix","text":"Creates instance ODMatrix(origin/destination) conventional form simwrapper","code":""},{"path":"https://vsp.berlin/matsim-r/reference/deriveODMatrix.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates an instance of ODMatrix(origin/destination) in conventional form or for the simwrapper — deriveODMatrix","text":"","code":"deriveODMatrix( tripsTable, shapePath, crs, dump.output.to = matsimDumpOutputDirectory, simwrapper = FALSE, colnames = \"numeric\", outer = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/deriveODMatrix.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates an instance of ODMatrix(origin/destination) in conventional form or for the simwrapper — deriveODMatrix","text":"tripsTable table output trips(readTripsTable) path trips_output file shapePath full path shapefile (simwrapper TRUE, folder shapeFile contain also .dbf name) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation dump.output.path folder save csv file ODMatrix simwrapper create output simwrapper form set path shapefile colnames specific shapefile contains known columns, specified name columns OD. given get numeric values outer logical represent table contain outside flow shape, ","code":""},{"path":"https://vsp.berlin/matsim-r/reference/deriveODMatrix.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates an instance of ODMatrix(origin/destination) in conventional form or for the simwrapper — deriveODMatrix","text":"tibble origin/destination matrix","code":""},{"path":"https://vsp.berlin/matsim-r/reference/filterByRegion.html","id":null,"dir":"Reference","previous_headings":"","what":"Filtering of trips_table(from readTripsTable) depending on how they located in given shape — filterByRegion","title":"Filtering of trips_table(from readTripsTable) depending on how they located in given shape — filterByRegion","text":"Takes trips_table shapeTable(sf object file representing geographical data, can received using function st_read(path_to_file). Please aware filterByRegion currently works, one geometry loaded.) transforms objects match mutual CRS(network.xml MATSimOutputDirectory) filters trips table depending *.inshape flags: start.inshape = TRUE & end.inshape = TRUE return table contains trips inside given shape start.inshape = TRUE & end.inshape = FALSE return table contains trips starts shape ends shape start.inshape = FALSE & end.inshape = TRUE return table contains trips ends shape starts shape start.inshape = FALSE & end.inshape = FALSE return table contains trips starts ends given shape","code":""},{"path":"https://vsp.berlin/matsim-r/reference/filterByRegion.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filtering of trips_table(from readTripsTable) depending on how they located in given shape — filterByRegion","text":"","code":"filterByRegion( tripsTable, shapeTable, crs, start.inshape = TRUE, end.inshape = TRUE )"},{"path":"https://vsp.berlin/matsim-r/reference/filterByRegion.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filtering of trips_table(from readTripsTable) depending on how they located in given shape — filterByRegion","text":"tripsTable tibble trips_output (readTripsTable()) shapeTable sf object(data.frame geometries), can received using st_read(path_to_geographical_file) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation start.inshape bool, defines trips conclude (see Description) end.inshape bool, defines trips conclude (see Description)","code":""},{"path":"https://vsp.berlin/matsim-r/reference/filterByRegion.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filtering of trips_table(from readTripsTable) depending on how they located in given shape — filterByRegion","text":"tibble, filtered trips depending shapeTable special flags (see Description)","code":""},{"path":"https://vsp.berlin/matsim-r/reference/generateXYHexagonYaml.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates/adds XY hexagon definition of output trips to a summary dashboard — generateXYHexagonYaml","title":"Creates/adds XY hexagon definition of output trips to a summary dashboard — generateXYHexagonYaml","text":"Creates/adds XY hexagon definition output trips summary dashboard","code":""},{"path":"https://vsp.berlin/matsim-r/reference/generateXYHexagonYaml.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates/adds XY hexagon definition of output trips to a summary dashboard — generateXYHexagonYaml","text":"","code":"generateXYHexagonYaml( pathToOutputTrips, crs, dump.output.to = matsimDumpOutputDirectory )"},{"path":"https://vsp.berlin/matsim-r/reference/generateXYHexagonYaml.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates/adds XY hexagon definition of output trips to a summary dashboard — generateXYHexagonYaml","text":"pathToOutputTrips specifies path data source output_trips crs specifies coordinate reference system output_trips dump.output.path folder dashboard","code":""},{"path":"https://vsp.berlin/matsim-r/reference/generateXYHexagonYaml.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates/adds XY hexagon definition of output trips to a summary dashboard — generateXYHexagonYaml","text":"changed file","code":""},{"path":"https://vsp.berlin/matsim-r/reference/generate_html_docs.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate html docs from roxygen2 docs — generate_html_docs","title":"Generate html docs from roxygen2 docs — generate_html_docs","text":"https://stackoverflow.com/questions/30897301/export-r-package-documentation---web-page","code":""},{"path":"https://vsp.berlin/matsim-r/reference/generate_html_docs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate html docs from roxygen2 docs — generate_html_docs","text":"","code":"generate_html_docs(pkg, links = tools::findHTMLlinks())"},{"path":"https://vsp.berlin/matsim-r/reference/generate_html_docs.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Generate html docs from roxygen2 docs — generate_html_docs","text":"exported, internal use ","code":""},{"path":"https://vsp.berlin/matsim-r/reference/getCrsFromConfig.html","id":null,"dir":"Reference","previous_headings":"","what":"Reads an coordinate referenec system of MATSim output directory\nfrom output_config.xml — getCrsFromConfig","title":"Reads an coordinate referenec system of MATSim output directory\nfrom output_config.xml — getCrsFromConfig","text":"Reads coordinate referenec system MATSim output directory output_config.xml","code":""},{"path":"https://vsp.berlin/matsim-r/reference/getCrsFromConfig.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reads an coordinate referenec system of MATSim output directory\nfrom output_config.xml — getCrsFromConfig","text":"","code":"getCrsFromConfig(folder)"},{"path":"https://vsp.berlin/matsim-r/reference/getCrsFromConfig.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reads an coordinate referenec system of MATSim output directory\nfrom output_config.xml — getCrsFromConfig","text":"folder specifies path find config","code":""},{"path":"https://vsp.berlin/matsim-r/reference/getCrsFromConfig.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reads an coordinate referenec system of MATSim output directory\nfrom output_config.xml — getCrsFromConfig","text":"code coordinate reference system","code":""},{"path":"https://vsp.berlin/matsim-r/reference/loadNetwork.html","id":null,"dir":"Reference","previous_headings":"","what":"Load MATSim network into memory — loadNetwork","title":"Load MATSim network into memory — loadNetwork","text":"Loads MATSim XML network file, creating nodes tibble links tibble. node link attribute records network stored additional columns respective node link tibbles.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/loadNetwork.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Load MATSim network into memory — loadNetwork","text":"","code":"loadNetwork(filename)"},{"path":"https://vsp.berlin/matsim-r/reference/loadNetwork.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Load MATSim network into memory — loadNetwork","text":"filename File load. Can XML gzipped XML","code":""},{"path":"https://vsp.berlin/matsim-r/reference/loadNetwork.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Load MATSim network into memory — loadNetwork","text":"\"nodes\" \"links\" tibbles list object.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/loadNetwork.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Load MATSim network into memory — loadNetwork","text":"links table automatically joined nodes table node x/y coordinates (node attributes) available links table without additional processing.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotAverageTravelWait.html","id":null,"dir":"Reference","previous_headings":"","what":"Bar Chart with main_mode on x-axis and average travel/wait time on y-axis — plotAverageTravelWait","title":"Bar Chart with main_mode on x-axis and average travel/wait time on y-axis — plotAverageTravelWait","text":"Takes Table trips_output (readTripsTable()), plot bar chart values represent time spent traveling/waiting Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotAverageTravelWait.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Bar Chart with main_mode on x-axis and average travel/wait time on y-axis — plotAverageTravelWait","text":"","code":"plotAverageTravelWait( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotAverageTravelWait.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bar Chart with main_mode on x-axis and average travel/wait time on y-axis — plotAverageTravelWait","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotAverageTravelWait.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Bar Chart with main_mode on x-axis and average travel/wait time on y-axis — plotAverageTravelWait","text":"Bar Chart plot average time spent travel/wait","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotDistanceTraveledByType.html","id":null,"dir":"Reference","previous_headings":"","what":"Bar Chart with tripType on x-axis and travelled distance on y-axis — plotDistanceTraveledByType","title":"Bar Chart with tripType on x-axis and travelled distance on y-axis — plotDistanceTraveledByType","text":"Takes Table trips_output (readTripsTable()), plot bar chart values represent travelled distance tripType related shapeTable","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotDistanceTraveledByType.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Bar Chart with tripType on x-axis and travelled distance on y-axis — plotDistanceTraveledByType","text":"","code":"plotDistanceTraveledByType( tripsTable, shapeTable, crs, dump.output.to = matsimDumpOutputDirectory )"},{"path":"https://vsp.berlin/matsim-r/reference/plotDistanceTraveledByType.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bar Chart with tripType on x-axis and travelled distance on y-axis — plotDistanceTraveledByType","text":"tripsTable tible trips_output (readTripsTable()) shapeTable sf object(data.frame geometries), can received using st_read(path_to_geographical_file) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotDistanceTraveledByType.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Bar Chart with tripType on x-axis and travelled distance on y-axis — plotDistanceTraveledByType","text":"Bar Chart plot average time spent travel/wait","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotEndActCountByArrTime.html","id":null,"dir":"Reference","previous_headings":"","what":"Scatter plot with arrival time x-axis and number end activities on y-axis — plotEndActCountByArrTime","title":"Scatter plot with arrival time x-axis and number end activities on y-axis — plotEndActCountByArrTime","text":"Takes Table trips_output (readTripsTable()), plot scatter plot values represent count end activities specific arrival time Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotEndActCountByArrTime.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Scatter plot with arrival time x-axis and number end activities on y-axis — plotEndActCountByArrTime","text":"","code":"plotEndActCountByArrTime( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotEndActCountByArrTime.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Scatter plot with arrival time x-axis and number end activities on y-axis — plotEndActCountByArrTime","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotEndActCountByArrTime.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Scatter plot with arrival time x-axis and number end activities on y-axis — plotEndActCountByArrTime","text":"Bar Chart plot distance traveled per mode","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTrips.html","id":null,"dir":"Reference","previous_headings":"","what":"Plots result of filtered trips on the map (from shape) — plotMapWithTrips","title":"Plots result of filtered trips on the map (from shape) — plotMapWithTrips","text":"Takes trips_table shapeTable(sf object file representing geographical data, can received using function st_read(path_to_file)) transforms objects match mutual CRS(network.xml MATSimOutputDirectory) filters trips table depending *.inshape flags: start.inshape = TRUE & end.inshape = TRUE return table contains trips inside given shape start.inshape = TRUE & end.inshape = FALSE return table contains trips starts shape ends shape start.inshape = FALSE & end.inshape = TRUE return table contains trips ends shape starts shape start.inshape = FALSE & end.inshape = FALSE return table contains trips starts ends given shape result filtering plotted map shapeTable green points startpoints trip red points endpoints trip","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTrips.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plots result of filtered trips on the map (from shape) — plotMapWithTrips","text":"","code":"plotMapWithTrips( table, shapeTable, crs, start.inshape = TRUE, end.inshape = TRUE, optimized = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTrips.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plots result of filtered trips on the map (from shape) — plotMapWithTrips","text":"table tibble trips_output (readTripsTable()) shapeTable sf object(data.frame geometries), can received using st_read(path_to_geographical_file) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation start.inshape bool, defines trips conclude (see Description) end.inshape bool, defines trips conclude (see Description) optimized bool, default FALSE gives interactive plot using leaflet, TRUE using image ggplot","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTrips.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plots result of filtered trips on the map (from shape) — plotMapWithTrips","text":"plot trips filtered depending flags *.inshape map shapeTable","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTripsType.html","id":null,"dir":"Reference","previous_headings":"","what":"Plots every type of trips(inside, outside, origin and destinating) on map — plotMapWithTripsType","title":"Plots every type of trips(inside, outside, origin and destinating) on map — plotMapWithTripsType","text":"Plots every type trips(inside, outside, origin destinating) map","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTripsType.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plots every type of trips(inside, outside, origin and destinating) on map — plotMapWithTripsType","text":"","code":"plotMapWithTripsType(table, shapeTable, crs, optimized = FALSE)"},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTripsType.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plots every type of trips(inside, outside, origin and destinating) on map — plotMapWithTripsType","text":"table tibble trips_output (readTripsTable()) shapeTable sf object(data.frame geometries), can received using st_read(path_to_geographical_file) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation optimized bool, default FALSE gives interactive plot using leaflet, TRUE using image ggplot","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotMapWithTripsType.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plots every type of trips(inside, outside, origin and destinating) on map — plotMapWithTripsType","text":"plot contains every trip defined trip type","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftBar.html","id":null,"dir":"Reference","previous_headings":"","what":"Plot bar chart diagram of transport mode changes — plotModalShiftBar","title":"Plot bar chart diagram of transport mode changes — plotModalShiftBar","text":"Takes two trips_table (readTripsTable), collects changes transport mode distribution tables make bar chart diagram dodging positioning data","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftBar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plot bar chart diagram of transport mode changes — plotModalShiftBar","text":"","code":"plotModalShiftBar( tripsTable1, tripsTable2, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, output.name = \"modalShiftBarChart\" )"},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftBar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plot bar chart diagram of transport mode changes — plotModalShiftBar","text":"tripsTable1 tible trips_output (readTripsTable()) tripsTable2 tible trips_output (readTripsTable()) unite.columns vector character string, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name columns united, can specify name resulting column plot dump.output.folder saves configures yaml simwrapper. folder png plot stored","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftBar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plot bar chart diagram of transport mode changes — plotModalShiftBar","text":"Alluvial diagram represents changes transport mode distribution trip tables","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftBar.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Plot bar chart diagram of transport mode changes — plotModalShiftBar","text":"Function calculates number transport mode used first second table, draws plot represent distribution transport mode changed (f. e. part concrete trasport mode changed another) Using parameter unite.columns transport modes match PATTERN unite.columns can united 1 transport mode type (default united.name \"united\") Using parameter show.onlyChanges","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftSankey.html","id":null,"dir":"Reference","previous_headings":"","what":"Plot alluvial/sankey diagram of transport mode changes — plotModalShiftSankey","title":"Plot alluvial/sankey diagram of transport mode changes — plotModalShiftSankey","text":"Takes two trips_table (readTripsTable), collects changes transport mode distribution tables make alluvial diagram data","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftSankey.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plot alluvial/sankey diagram of transport mode changes — plotModalShiftSankey","text":"","code":"plotModalShiftSankey( tripsTable1, tripsTable2, show.onlyChanges = FALSE, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory )"},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftSankey.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plot alluvial/sankey diagram of transport mode changes — plotModalShiftSankey","text":"tripsTable1 tible trips_output (readTripsTable()) tripsTable2 tible trips_output (readTripsTable()) show.onlyChanges boolean, set TRUE => sankey diagram contains changes axes unite.columns vector character string, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name columns united, can specify name resulting column plot dump.output.folder saves configures yaml simwrapper. folder png plot stored","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftSankey.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plot alluvial/sankey diagram of transport mode changes — plotModalShiftSankey","text":"Alluvial diagram represents changes transport mode distribution trip tables","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalShiftSankey.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Plot alluvial/sankey diagram of transport mode changes — plotModalShiftSankey","text":"Function calculates number transport mode used first second table, draws plot represent distribution transport mode changed (f. e. part concrete trasport mode changed another) Using parameter unite.columns transport modes match PATTERN unite.columns can united 1 transport mode type (default united.name \"united\") Using parameter show.onlyChanges","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitBarChart.html","id":null,"dir":"Reference","previous_headings":"","what":"Plot main_mode as a bar Chart — plotModalSplitBarChart","title":"Plot main_mode as a bar Chart — plotModalSplitBarChart","text":"Takes Table trips_output (readTripsTable()), plot bar chart values represent percentage using transport modes trips","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitBarChart.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plot main_mode as a bar Chart — plotModalSplitBarChart","text":"","code":"plotModalSplitBarChart( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitBarChart.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plot main_mode as a bar Chart — plotModalSplitBarChart","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitBarChart.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plot main_mode as a bar Chart — plotModalSplitBarChart","text":"Bar Chart plot transport mode distribution, values given percents","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitBarChart.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Plot main_mode as a bar Chart — plotModalSplitBarChart","text":"Function automatically detects transport_modes table plots pie chart percentage distribution. Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitPieChart.html","id":null,"dir":"Reference","previous_headings":"","what":"Plot main_mode as a Pie Chart — plotModalSplitPieChart","title":"Plot main_mode as a Pie Chart — plotModalSplitPieChart","text":"Takes Table trips_output (readTripsTable()), plot pie chart values represent percentage using transport modes trips","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitPieChart.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plot main_mode as a Pie Chart — plotModalSplitPieChart","text":"","code":"plotModalSplitPieChart( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitPieChart.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plot main_mode as a Pie Chart — plotModalSplitPieChart","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitPieChart.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plot main_mode as a Pie Chart — plotModalSplitPieChart","text":"Pie Chart plot transport mode distribution, values given percents","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotModalSplitPieChart.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Plot main_mode as a Pie Chart — plotModalSplitPieChart","text":"Function automatically detects transport_modes table plots pie chart. Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotStartActCountByDepTime.html","id":null,"dir":"Reference","previous_headings":"","what":"Scatter plot with departure time x-axis and number start activities on y-axis — plotStartActCountByDepTime","title":"Scatter plot with departure time x-axis and number start activities on y-axis — plotStartActCountByDepTime","text":"Takes Table trips_output (readTripsTable()), plot scatter plot values represent count start activities specific departure time main_mode Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotStartActCountByDepTime.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Scatter plot with departure time x-axis and number start activities on y-axis — plotStartActCountByDepTime","text":"","code":"plotStartActCountByDepTime( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotStartActCountByDepTime.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Scatter plot with departure time x-axis and number start activities on y-axis — plotStartActCountByDepTime","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotStartActCountByDepTime.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Scatter plot with departure time x-axis and number start activities on y-axis — plotStartActCountByDepTime","text":"Bar Chart plot distance traveled per mode","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripCountByDepTime.html","id":null,"dir":"Reference","previous_headings":"","what":"Scatter plot with departure time x-axis and number of trips on y-axis — plotTripCountByDepTime","title":"Scatter plot with departure time x-axis and number of trips on y-axis — plotTripCountByDepTime","text":"Takes Table trips_output (readTripsTable()), plot scatter plot values represent count trips specific departure time main_mode Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripCountByDepTime.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Scatter plot with departure time x-axis and number of trips on y-axis — plotTripCountByDepTime","text":"","code":"plotTripCountByDepTime( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotTripCountByDepTime.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Scatter plot with departure time x-axis and number of trips on y-axis — plotTripCountByDepTime","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripCountByDepTime.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Scatter plot with departure time x-axis and number of trips on y-axis — plotTripCountByDepTime","text":"Bar Chart plot distance traveled per mode","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripDistanceByMode.html","id":null,"dir":"Reference","previous_headings":"","what":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripDistanceByMode","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripDistanceByMode","text":"Takes Table trips_output (readTripsTable()), plot bar chart values represent average distance traveled ~ main mode used Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripDistanceByMode.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripDistanceByMode","text":"","code":"plotTripDistanceByMode( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotTripDistanceByMode.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripDistanceByMode","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripDistanceByMode.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripDistanceByMode","text":"Bar Chart plot distance traveled per mode","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripTypesPieChart.html","id":null,"dir":"Reference","previous_headings":"","what":"Plots distribution of every type of trips(inside, outside, origin and destinating) in Pie Chart — plotTripTypesPieChart","title":"Plots distribution of every type of trips(inside, outside, origin and destinating) in Pie Chart — plotTripTypesPieChart","text":"Plots distribution every type trips(inside, outside, origin destinating) Pie Chart","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripTypesPieChart.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plots distribution of every type of trips(inside, outside, origin and destinating) in Pie Chart — plotTripTypesPieChart","text":"","code":"plotTripTypesPieChart(table, shapeTable, crs)"},{"path":"https://vsp.berlin/matsim-r/reference/plotTripTypesPieChart.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plots distribution of every type of trips(inside, outside, origin and destinating) in Pie Chart — plotTripTypesPieChart","text":"table tibble trips_output (readTripsTable()) shapeTable sf object(data.frame geometries), can received using st_read(path_to_geographical_file) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripTypesPieChart.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plots distribution of every type of trips(inside, outside, origin and destinating) in Pie Chart — plotTripTypesPieChart","text":"plot percentage type trips","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripsByDistance.html","id":null,"dir":"Reference","previous_headings":"","what":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripsByDistance","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripsByDistance","text":"Takes Table trips_output (readTripsTable()), plot bar chart values represent number trips ~ distance travelled Using parameters unite.columns, specific columns given, unite 1 mode name united.name(default 'united')","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripsByDistance.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripsByDistance","text":"","code":"plotTripsByDistance( tripsTable, unite.columns = character(0), united.name = \"united\", dump.output.to = matsimDumpOutputDirectory, only.files = FALSE )"},{"path":"https://vsp.berlin/matsim-r/reference/plotTripsByDistance.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripsByDistance","text":"tripsTable tible trips_output (readTripsTable()) unite.columns vector character strings, represent patterns columns united, changes name transport modes tibble copy united.name = \"united\" matches PATTERNS given unite.columns united.name character string, columns united, can specify name resulting column chart dump.output.folder saves configures yaml simwrapper dashboard. folder png plot stored .files boolean, represent plotting inside project needed, default FALSE - means function gives plot plot_ly","code":""},{"path":"https://vsp.berlin/matsim-r/reference/plotTripsByDistance.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Bar Chart with distance travelled on x-axis and number of trips on y-axis — plotTripsByDistance","text":"Bar Chart plot count trips among distance travelled","code":""},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromFolder.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromFolder","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromFolder","text":"Creates dashboard given table folder data","code":""},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromFolder.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromFolder","text":"","code":"prepareSimwrapperDashboardFromFolder( folder = \"./\", dump.output.to = matsimDumpOutputDirectory, append = TRUE )"},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromFolder.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromFolder","text":"folder specifies data source folder tripsOutput dump.output.folder saves configures yaml simwrapper dashboard plots append specifies output folder erased creating","code":""},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromFolder.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromFolder","text":"tibble output_trips folder. Generates content needed Simwrapper","code":""},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromTable.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromTable","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromTable","text":"Creates dashboard given table folder data","code":""},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromTable.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromTable","text":"","code":"prepareSimwrapperDashboardFromTable( table, dump.output.to = matsimDumpOutputDirectory, append = TRUE )"},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromTable.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromTable","text":"table trips_output tibble readTripsTable() dump.output.folder saves configures yaml simwrapper dashboard plots using functions: plotModalSplitBarChart(),plotModalSplitPieChart(),plotModalShift(). append specifies output folder erased creating","code":""},{"path":"https://vsp.berlin/matsim-r/reference/prepareSimwrapperDashboardFromTable.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates dashboard for the given table or folder with data — prepareSimwrapperDashboardFromTable","text":"generates folder content simwrapper trips table","code":""},{"path":"https://vsp.berlin/matsim-r/reference/readTripsTable.html","id":null,"dir":"Reference","previous_headings":"","what":"Load MATSIM output_trips table into Memory — readTripsTable","title":"Load MATSIM output_trips table into Memory — readTripsTable","text":"Loads MATSim CSV output_trips file archive, creating tibble columns csv file","code":""},{"path":"https://vsp.berlin/matsim-r/reference/readTripsTable.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Load MATSIM output_trips table into Memory — readTripsTable","text":"","code":"readTripsTable(pathToMATSimOutputDirectory = \".\")"},{"path":"https://vsp.berlin/matsim-r/reference/readTripsTable.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Load MATSIM output_trips table into Memory — readTripsTable","text":"pathToMATSimOutputDirectory character string, path matsim output directory http link file.","code":""},{"path":"https://vsp.berlin/matsim-r/reference/readTripsTable.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Load MATSIM output_trips table into Memory — readTripsTable","text":"tibble trips_output","code":""},{"path":"https://vsp.berlin/matsim-r/reference/transformToSf.html","id":null,"dir":"Reference","previous_headings":"","what":"Transforms trips_table tibble (from readTripsTable) from tibble to sf (table with attribute features and geometry feature) — transformToSf","title":"Transforms trips_table tibble (from readTripsTable) from tibble to sf (table with attribute features and geometry feature) — transformToSf","text":"Takes trips_table (readTripsTable) transforms trips_table sf object using start_x, end_x, start_y, end_y geometry features deletes resulting data.frame start_x, end_x, start_y, end_y. adds wkt column, geometry.type = st_mulitpoint(), geometry.type = st_linestring() adds start_wkt end_wkt, geometry.type = st_point() Added column/columns projected given CRS (coordinate reference system), can taken network file MATSimOutputDirectory","code":""},{"path":"https://vsp.berlin/matsim-r/reference/transformToSf.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Transforms trips_table tibble (from readTripsTable) from tibble to sf (table with attribute features and geometry feature) — transformToSf","text":"","code":"transformToSf(table, crs, geometry.type = st_multipoint())"},{"path":"https://vsp.berlin/matsim-r/reference/transformToSf.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Transforms trips_table tibble (from readTripsTable) from tibble to sf (table with attribute features and geometry feature) — transformToSf","text":"table tibble trips_output (readTripsTable()) crs numeric EPSG code proj4string, can found network file output directory MATSim simulation geometry.type function sf transformation, geometry.type can (default st_multipoint()) !!!st_point()-resulting table contains 2 geometries start_wkt end_wkt, representing start end POINTs, type POINT!!! !!!st_multipoint()-resulting table contains 1 geometry wkt, representing start end POINTS MULTIPOINT!!! !!!st_linestring() - resulting table contains 1 geometry wkt, representing line start end points LINESTRING!!!","code":""},{"path":"https://vsp.berlin/matsim-r/reference/transformToSf.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Transforms trips_table tibble (from readTripsTable) from tibble to sf (table with attribute features and geometry feature) — transformToSf","text":"sf object (data.frame geometries depending geometry.type)","code":""},{"path":"https://vsp.berlin/matsim-r/reference/transformToSf.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Transforms trips_table tibble (from readTripsTable) from tibble to sf (table with attribute features and geometry feature) — transformToSf","text":"Function also sets attribute geometry.type resulting table character value \"POINT\",\"MULTIPOINT\",\"LINESTRING\" get type table generated, needed","code":""}]
Charlton B, Soboliev O (2022). matsim: R library for interfacing with MATSim agent-based microsimulation model. -R package version 0.1.6, https://github.com/matsim-vsp/matsim-r. +R package version 0.1.7, https://github.com/matsim-vsp/matsim-r.
@Manual{, title = {matsim: R library for interfacing with MATSim agent-based microsimulation model}, author = {Billy Charlton and Oleksandr Soboliev}, year = {2022}, - note = {R package version 0.1.6}, + note = {R package version 0.1.7}, url = {https://github.com/matsim-vsp/matsim-r}, }