Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
billyc committed Dec 12, 2022
1 parent 56168f3 commit 914c863
Show file tree
Hide file tree
Showing 35 changed files with 66 additions and 44 deletions.
5 changes: 3 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ Package: matsim
Type: Package
Title: R library for interfacing with MATSim agent-based microsimulation model
Version: 0.1.6
Author: Billy Charlton
Maintainer: Billy Charlton <[email protected]>
Authors@R: c(
person("Billy", "Charlton", email = "[email protected]", role=c("aut","cre")),
person("Oleksandr", "Soboliev", role="aut"))
Description: MATSim support package for R
MATSim <https://matsim.org> is an agent-based microsimulation package
for large-scale transport simulations. This package mimics the functionality
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ One very useful command builds a [SimWrapper](https://vsp.berlin/simwrapper) das

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

---

## Install

You can install the package right now:
Expand All @@ -31,6 +33,8 @@ 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
Expand Down
2 changes: 1 addition & 1 deletion docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/LICENSE.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 8 additions & 4 deletions docs/authors.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 20 additions & 7 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ pandoc: '2.18'
pkgdown: 2.0.6
pkgdown_sha: ~
articles: {}
last_built: 2022-12-12T12:12Z
last_built: 2022-12-12T13:16Z

2 changes: 1 addition & 1 deletion docs/reference/compareBasePolicyOutput.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/compareBasePolicyShapeOutput.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/compareTripTypesBarChart.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/deriveODMatrix.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/filterByRegion.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/generateXYHexagonYaml.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/getCrsFromConfig.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/loadNetwork.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotAverageTravelWait.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotDistanceTraveledByType.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotEndActCountByArrTime.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotMapWithTrips.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotMapWithTripsType.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotModalShiftBar.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotModalShiftSankey.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotModalSplitBarChart.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotModalSplitPieChart.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotStartActCountByDepTime.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotTripCountByDepTime.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotTripDistanceByMode.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotTripTypesPieChart.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/plotTripsByDistance.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/prepareSimwrapperDashboardFromFolder.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/prepareSimwrapperDashboardFromTable.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/readTripsTable.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 914c863

Please sign in to comment.