Skip to content

Commit 51fa7d4

Browse files
authored
Add badge and fix small bugs (#39)
* Add Project Status badge * Correct links to vignettes * Update _pkgdown.yml
1 parent 0592c0a commit 51fa7d4

File tree

4 files changed

+13
-3
lines changed

4 files changed

+13
-3
lines changed

README.Rmd

+1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ knitr::opts_chunk$set(
2323
<!-- badges: start -->
2424
[![Github Action test](https://github.com/sodascience/osmenrich/workflows/R-CMD-check/badge.svg)](https://github.com/sodascience/osmenrich/actions)
2525
[![DOI](https://zenodo.org/badge/337555188.svg)](https://zenodo.org/badge/latestdoi/337555188)
26+
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
2627
<!-- badges: end -->
2728

2829
The goal of `osmenrich` is to easily enrich geocoded data

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
[![Github Action
1616
test](https://github.com/sodascience/osmenrich/workflows/R-CMD-check/badge.svg)](https://github.com/sodascience/osmenrich/actions)
1717
[![DOI](https://zenodo.org/badge/337555188.svg)](https://zenodo.org/badge/latestdoi/337555188)
18+
[![Project Status: Active – The project has reached a stable, usable
19+
state and is being actively
20+
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
1821
<!-- badges: end -->
1922

2023
The goal of `osmenrich` is to easily enrich geocoded data

pkgdown/_pkgdown.yml

+5-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ reference:
3838
- title: Retrieve and compute distances and durations
3939
desc: Functions used to retrieve distances and duration from OSRM servers and kernel functions used to compute aggregation of these metrics.
4040
- contents:
41-
- distance_funs
41+
- measure_funs
4242
- kernels
4343
- title: OSRM functions
4444
desc: Functions to communicate with remote or local OSRM servers.
@@ -55,6 +55,10 @@ reference:
5555
- url_available
5656
- adjust_coord
5757
- format_coord_table
58+
- title: Example data
59+
desc: Example dataframe for basic enrichments.
60+
- contents:
61+
- common_swift
5862

5963
navbar:
6064
structure:

vignettes/osmenrich.Rmd

+4-2
Original file line numberDiff line numberDiff line change
@@ -212,8 +212,10 @@ sf_example_advanced
212212
# > 2 Bob 2 2 (5.08 52.13) 0
213213
```
214214

215-
### Advanced Example
215+
### Advanced Examples
216216

217-
For a more advanced example in which `osmenrich` is put to use with other packages, please refer to [this tutorial](advanced_enrichment.Rmd).
217+
For a more advanced example in which `osmenrich` is put to use with other packages, please refer to [this tutorial](advanced_enrichment).
218+
219+
For an example on the working of kernels within `osmenrich`, please refer to [this tutorial](introduction_kernels).
218220

219221

0 commit comments

Comments
 (0)