{"Package":"omxr","Type":"Package","Title":"Read and Write Open Matrix Files","Version":"0.3.3","Date":"2020-09-16","Authors@R":"c(\nperson(\"Brian\", \"Gregor\", email = \"\", role = \"aut\"),\nperson(\"Ben\", \"Stabler\", email = \"\", role = \"aut\"),\nperson(\"Greg\", \"Macfarlane\", email = \"gregmacfarlane@gmail.com\", role = \"cre\") )","Description":"The Open Matrix (OMX) file type is an open specification for\nsharing data from transportation models. The specification is built on\nHDF5 ;\nAPIs to read and write are available for 'Cube', 'Emme', 'Python', 'Java',\nand 'R'.","License":"Apache License 2.0","LazyData":"TRUE","Suggests":"knitr, tidyverse","VignetteBuilder":"knitr","biocViews":"rhdf5, zlibbioc","Imports":"rhdf5, hms, zlibbioc, tidyr (>= 0.8.0), readr, dplyr, purrr,\nmagrittr, rlang","RoxygenNote":"7.1.1","NeedsCompilation":"no","Packaged":"2020-09-17 16:53:48 UTC; gregmacfarlane","Author":"Brian Gregor [aut],\nBen Stabler [aut],\nGreg Macfarlane [cre]","Maintainer":"Greg Macfarlane ","Repository":"CRAN","Date/Publication":"2020-09-23 15:30:03 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/omxr_0.3.3.tar.gz","jsonAuthors":[{"name":"Brian Gregor","email":null,"maintainer":false},{"name":"Ben Stabler","email":null,"maintainer":false},{"name":"Greg Macfarlane","email":"gregmacfarlane@gmail.com","maintainer":true}],"readme":"\n\n\n# omxr\n\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/omxr)](https://cran.r-project.org/package=omxr)\n[![Build\nStatus](https://travis-ci.org/gregmacfarlane/omxr.svg?branch=master)](https://travis-ci.org/gregmacfarlane/omxr)\n\nThe goal of omxr is to provide a convenient API for R users working with\nOpen Matrix (OMX) format files. For more details on the file standard,\nsee the [osPlanning wiki](https://github.com/osPlanning/omx/wiki).\n\n## Installation\n\nWe hope to have omxr on [CRAN](https://CRAN.R-project.org) in the near\nfuture. Until then, you can install omxr with the\n[devtools](https://cran.r-project.org/package=devtools) package\n\n``` r\ndevtools::install_github(\"gregmacfarlane/omxr\")\n```\n\n## Example\n\nWith omxr you can examine the contents of existing OMX files within R.\n\n``` r\n# path to the omx file\nomx_file <- omxr_example(\"skims.omx\")\n\n# list contents\nlist_omx(omx_file)\n#> $OMXVersion\n#> [1] \"0.2\"\n#> \n#> $Rows\n#> [1] 25\n#> \n#> $Columns\n#> [1] 25\n#> \n#> $Matrices\n#> name dclass dim type\n#> 1 DIST FLOAT 25 x 25 matrix\n#> 2 DISTBIKE FLOAT 25 x 25 matrix\n#> 3 DISTWALK FLOAT 25 x 25 matrix\n#> 4 DRV_LOC_WLK_DDIST__AM FLOAT 25 x 25 matrix\n#> 5 DRV_LOC_WLK_DTIM__AM FLOAT 25 x 25 matrix\n#> 6 DRV_LOC_WLK_FAR__AM FLOAT 25 x 25 matrix\n#> 7 DRV_LOC_WLK_IWAIT__AM FLOAT 25 x 25 matrix\n#> 8 DRV_LOC_WLK_TOTIVT__AM FLOAT 25 x 25 matrix\n#> 9 DRV_LOC_WLK_WAIT__AM FLOAT 25 x 25 matrix\n#> 10 DRV_LOC_WLK_WAUX__AM FLOAT 25 x 25 matrix\n#> 11 DRV_LOC_WLK_XWAIT__AM FLOAT 25 x 25 matrix\n#> 12 HOV2TOLL_BTOLL__AM FLOAT 25 x 25 matrix\n#> 13 HOV2TOLL_DIST__AM FLOAT 25 x 25 matrix\n#> 14 HOV2TOLL_TIME__AM FLOAT 25 x 25 matrix\n#> 15 HOV2TOLL_VTOLL__AM FLOAT 25 x 25 matrix\n#> 16 HOV2_BTOLL__AM FLOAT 25 x 25 matrix\n#> 17 HOV2_DIST__AM FLOAT 25 x 25 matrix\n#> 18 HOV2_TIME__AM FLOAT 25 x 25 matrix\n#> 19 HOV3_BTOLL__AM FLOAT 25 x 25 matrix\n#> 20 HOV3_DIST__AM FLOAT 25 x 25 matrix\n#> 21 HOV3_TIME__AM FLOAT 25 x 25 matrix\n#> 22 SOVTOLL_BTOLL__AM FLOAT 25 x 25 matrix\n#> 23 SOVTOLL_DIST__AM FLOAT 25 x 25 matrix\n#> 24 SOVTOLL_TIME__AM FLOAT 25 x 25 matrix\n#> 25 SOVTOLL_VTOLL__AM FLOAT 25 x 25 matrix\n#> 26 SOV_BTOLL__AM FLOAT 25 x 25 matrix\n#> 27 SOV_DIST__AM FLOAT 25 x 25 matrix\n#> 28 SOV_TIME__AM FLOAT 25 x 25 matrix\n#> 29 WLK_LOC_DRV_BOARDS__AM FLOAT 25 x 25 matrix\n#> 30 WLK_LOC_DRV_DDIST__AM FLOAT 25 x 25 matrix\n#> 31 WLK_LOC_DRV_DTIM__AM FLOAT 25 x 25 matrix\n#> 32 WLK_LOC_DRV_FAR__AM FLOAT 25 x 25 matrix\n#> 33 WLK_LOC_DRV_IWAIT__AM FLOAT 25 x 25 matrix\n#> 34 WLK_LOC_DRV_TOTIVT__AM FLOAT 25 x 25 matrix\n#> 35 WLK_LOC_DRV_WAIT__AM FLOAT 25 x 25 matrix\n#> 36 WLK_LOC_DRV_WAUX__AM FLOAT 25 x 25 matrix\n#> 37 WLK_LOC_DRV_XWAIT__AM FLOAT 25 x 25 matrix\n#> 38 WLK_LOC_WLK_BOARDS__AM FLOAT 25 x 25 matrix\n#> 39 WLK_LOC_WLK_FAR__AM FLOAT 25 x 25 matrix\n#> 40 WLK_LOC_WLK_IWAIT__AM FLOAT 25 x 25 matrix\n#> 41 WLK_LOC_WLK_TOTIVT__AM FLOAT 25 x 25 matrix\n#> 42 WLK_LOC_WLK_WAIT__AM FLOAT 25 x 25 matrix\n#> 43 WLK_LOC_WLK_WAUX__AM FLOAT 25 x 25 matrix\n#> 44 WLK_LOC_WLK_XWAIT__AM FLOAT 25 x 25 matrix\n#> 45 WLK_TRN_WLK_IVT__AM FLOAT 25 x 25 matrix\n#> 46 WLK_TRN_WLK_IVT__MD FLOAT 25 x 25 matrix\n#> 47 WLK_TRN_WLK_IVT__PM FLOAT 25 x 25 matrix\n#> 48 WLK_TRN_WLK_IWAIT__AM FLOAT 25 x 25 matrix\n#> 49 WLK_TRN_WLK_WACC__AM FLOAT 25 x 25 matrix\n#> 50 WLK_TRN_WLK_WAUX__AM FLOAT 25 x 25 matrix\n#> 51 WLK_TRN_WLK_WEGR__AM FLOAT 25 x 25 matrix\n#> 52 WLK_TRN_WLK_XWAIT__AM FLOAT 25 x 25 matrix\n#> \n#> $Lookups\n#> name dclass dim lookupdim description\n#> 54 Districts INTEGER 25 Districts\n#> 55 EI STRING 25 External and Internal Zones\n```\n\nYou can choose to read the matrix as either an R matrix or as a\ntidyverse-friendly tibble, depending on your needs.\n\n``` r\nm <- read_omx(omx_file, \"DIST\") # return an array\nm[1:5, 1:5]\n#> [,1] [,2] [,3] [,4] [,5]\n#> [1,] 0.12 0.24 0.44 0.41 0.68\n#> [2,] 0.37 0.14 0.28 0.29 0.59\n#> [3,] 0.57 0.28 0.14 0.46 0.45\n#> [4,] 0.34 0.24 0.33 0.12 0.35\n#> [5,] 0.70 0.64 0.52 0.40 0.20\n\nread_all_omx(omx_file, c(\"DIST\", \"DISTBIKE\", \"DISTWALK\"))\n#> # A tibble: 625 x 5\n#> origin destination DIST DISTBIKE DISTWALK\n#> \n#> 1 1 1 0.12 0.12 0.12\n#> 2 1 2 0.24 0.24 0.24\n#> 3 1 3 0.44 0.44 0.44\n#> 4 1 4 0.41 0.41 0.41\n#> 5 1 5 0.68 0.68 0.68\n#> 6 1 6 0.97 0.97 0.97\n#> 7 1 7 0.98 0.98 0.98\n#> 8 1 8 1.15 1.15 1.15\n#> 9 1 9 1.56 1.56 1.56\n#> 10 1 10 1.59 1.59 1.59\n#> # … with 615 more rows\n```\n\nMore detailed examples, including creating and writing to OMX files, are\navailable in the package vignette.\n\n``` r\nvignette(omxr)\n```","jobInfo":{"package":"omxr","version":"0.3.3","parsingStatus":"success","parserVersion":1,"parsedAt":"2020-09-23T16:30:19+0000"}}

Description

Arguments