Skip to content

Commit c024a9e

Browse files
committed
another round of pre cran corrections
1 parent bd26512 commit c024a9e

4 files changed

Lines changed: 24 additions & 14 deletions

File tree

DESCRIPTION

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,21 @@ Package: cppSim
22
Title: Fast and Memory Efficient Spatial Interaction Models
33
Version: 0.2
44
Authors@R:
5-
person("Ivann", "Schlosser", , "ivann.schlosser.19@ucl.ac.uk", role = c("aut", "cre"),
5+
person(given = "Ivann", family = "Schlosser", email = "ivann.schlosser.19@ucl.ac.uk", role = c("aut", "cre"),
66
comment = c(ORCID = "0009-0004-4099-3198"))
7+
Author: Ivann Schlosser [aut, cre] (<https://orcid.org/0009-0004-4099-3198>)
78
Maintainer: Ivann Schlosser <ivann.schlosser.19@ucl.ac.uk>
89
Description: Building on top of the 'RcppArmadillo' linear
910
algebra functionalities to do fast spatial interaction models in the
1011
context of urban analytics, geography, transport modelling. It uses
1112
the Newton root search algorithm to determine the optimal cost
1213
exponent and can run country level models with thousands of origins
1314
and destinations. It aims at implementing an easy approach based on
14-
matrices. Currently, the simplest form of production, destination and
15+
matrices, that can originate from various routing and processing steps earlier in an workflow.
16+
Currently, the simplest form of production, destination and
1517
doubly constrained models are implemented.
16-
Date: 2025-04-17
18+
Schlosser et al. (2023) <doi:10.48550/arXiv.2309.02112>.
19+
Date: 2025-08-29
1720
License: MIT + file LICENSE
1821
URL: https://ischlo.github.io/cppSim/, https://github.com/ischlo/cppSim
1922
Depends:

README.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ model_test <- run_model(
7575

7676
For an example of what can be done with this package, please refer to the publication on active travel spatial interaction models in London for which it was originally developed.
7777

78-
> [Schlosser, I., Maureira, V.M., Milton, R., Arcaute, E., Batty, M., 2023. Active-travel modelling: a methodological approach to networks for walking and cycling commuting analysis.](http://arxiv.org/abs/2309.02112)
78+
> [Schlosser, I., Maureira, V.M., Milton, R., Arcaute, E., Batty, M., 2023. Active-travel modelling: a methodological approach to networks for walking and cycling commuting analysis.](https://arxiv.org/abs/2309.02112)
7979
8080
The accompanying code for the analysis is provided in the [`ischlo/quant_cycle_walk`](https://github.com/ischlo/quant_cycle_walk) repository.
8181

@@ -93,7 +93,7 @@ On the R side, it uses `Rcpp` [@eddelbuettel2011] and `RcppArmadillo` [@eddelbue
9393

9494
## Performance
9595

96-
Compared to the equivalent functions implemented in pure R, it runs about x10 faster for a $\sim 1000\times 1000$ OD matrix, the speed up is increasingly more significant as matrices get bigger.
96+
Compared to the equivalent functions implemented in pure R, it runs about x10 faster for a $\sim 1000 \times 1000$ OD matrix, the speed up is increasingly more significant as matrices get bigger.
9797

9898
```{r performance,eval=TRUE,include=TRUE,echo = FALSE}
9999

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://
1414
![](https://github.com/ischlo/cppSim/actions/workflows/rhub.yaml/badge.svg)
1515

1616
<!-- ![](https://github.com/ischlo/cppSim/actions/workflows/test-coverage.yaml/badge.svg) -->
17+
1718
<!-- badges: end -->
1819

1920
This aims at providing a set of fast, memory efficient functions to
@@ -82,7 +83,7 @@ for which it was originally developed.
8283
> [Schlosser, I., Maureira, V.M., Milton, R., Arcaute, E., Batty, M.,
8384
> 2023. Active-travel modelling: a methodological approach to networks
8485
> for walking and cycling commuting
85-
> analysis.](http://arxiv.org/abs/2309.02112)
86+
> analysis.](https://arxiv.org/abs/2309.02112)
8687
8788
The accompanying code for the analysis is provided in the
8889
[`ischlo/quant_cycle_walk`](https://github.com/ischlo/quant_cycle_walk)
@@ -108,26 +109,27 @@ On the R side, it uses `Rcpp` \[@eddelbuettel2011\] and `RcppArmadillo`
108109
## Performance
109110

110111
Compared to the equivalent functions implemented in pure R, it runs
111-
about x10 faster for a $\sim 1000\times 1000$ OD matrix, the speed up is
112-
increasingly more significant as matrices get bigger.
112+
about x10 faster for a $`\sim 1000 \times 1000`$ OD matrix, the speed up
113+
is increasingly more significant as matrices get bigger.
113114

114115
[1] "/Users/cenv1069/Library/R/arm64/4.4/library/cppSim/extdata/benchmark_test.rds"
115116

116117
## Citation
117118

118119
To cite package 'cppSim' in publications use:
119120

120-
Schlosser I (2024). _cppSim: Fast and Memory Efficient Spatial
121-
Interaction Models_. R package version 0.2,
122-
https://github.com/ischlo/cppSim, <https://ischlo.github.io/cppSim/>.
121+
Schlosser I (2023). _cppSim: Fast and Memory Efficient Spatial
122+
Interaction Models_. doi:10.5281/zenodo.14367756
123+
<https://doi.org/10.5281/zenodo.14367756>,
124+
<https://ischlo.github.io/cppSim/>.
123125

124126
A BibTeX entry for LaTeX users is
125127

126128
@Manual{,
127129
title = {cppSim: Fast and Memory Efficient Spatial Interaction Models},
128130
author = {Ivann Schlosser},
129-
year = {2024},
130-
note = {R package version 0.2, https://github.com/ischlo/cppSim},
131+
year = {2023},
132+
doi = {10.5281/zenodo.14367756},
131133
url = {https://ischlo.github.io/cppSim/},
132134
}
133135

vignettes/getting_started_2.Rmd

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,15 @@ dim(flows_test)
5050

5151
```{r echo=FALSE, fig.show='hold', out.width="45%"}
5252
53-
par(cex = .6)
53+
oldpar <- par(cex = .6)
54+
5455
plot(density(distance_test), main = "Distribution of distances", xlab = "OD distance (km)")
5556
plot(density(flows_test), main = "Distribution of flows", xlab = "flow", log = "x")
5657
58+
# Restore
59+
par(oldpar)
60+
61+
5762
```
5863

5964
# Visualisation

0 commit comments

Comments
 (0)