Skip to content

Latest commit

 

History

History
47 lines (26 loc) · 1.96 KB

README.md

File metadata and controls

47 lines (26 loc) · 1.96 KB
Raw

MATSIM R support package

MATSim is an agent-based microsimulation package for large-scale transport simulations. It's free software under the terms of the GNU General Public License. The user guide to MATSim can be found here and more information regarding the license here.

This package mimics the functionality of the Python matsim-tools package, and will eventually support standard MATSim networks, plans and events.

Currently network files as well as many summarization plots based on the MATSim standard output_trips file, counts file and output_persons file are supported.

This work is preliminary and ongoing -- submissions are welcome!

Install

You can install the package right now:

  • If you don't already have devtools installed, first run this:

    • install.packages("devtools")

  • Then run:

    • devtools::install_github("matsim-vsp/matsim-r", build_vignettes = TRUE)

To install the package from a specific branch use: devtools::install_github("matsim-vsp/matsim-r",ref="{name of the branch}", build_vignettes = TRUE)

Installing from .gz archive

Instead of using devtools you can also install directly from the source archive:

  • install.packages("matsim-r.tar.gz", type="source", repos=NULL)

Documentation build instructions

Run GNU Make to build the docs whenever source files in R/ change. It will create the man pages as well as the fancy HTML docs/ folder

Or, build yourself:

  • devtools::document() builds docs and NAMESPACE
  • pkgdown::build_site() builds the HTML docs

Vignettes

The package includes several vignettes containing short guides and some examples. To access them make sure to build the vignettes during the installation process using build_vignettes=TRUE.

browseVignettes(package = "matsim") will open a list of currently available vignettes.