Skip to content

Commit e4dfc85

Browse files
committed
Update docs with pkgdev
1 parent 3d1284e commit e4dfc85

18 files changed

+76
-20
lines changed

.Rbuildignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,6 @@
3939
^vignettes/articles/\.quarto$
4040
^vignettes/articles/*_files$
4141
^vignettes/articles$
42+
^vignettes/_quarto\.yaml$
43+
^vignettes/_quarto\.yml$
44+
^\.quarto$

.github/codecov.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
codecov:
2+
branch: main
3+
require_ci_to_pass: false
4+
5+
coverage:
6+
status:
7+
project:
8+
default:
9+
target: auto
10+
threshold: 1%
11+
informational: true
12+
patch:
13+
default:
14+
target: auto
15+
threshold: 1%
16+
informational: true
17+
18+
ignore:
19+
- data-raw/
20+
- inst/
21+
- vignettes/
22+
23+
github_checks:
24+
annotations: true

README.Rmd

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ output: github_document
44

55
<!-- README.md is generated from README.Rmd. Please edit that file -->
66

7-
```{r, include = FALSE}
7+
```{r}
8+
#| include: false
89
knitr::opts_chunk$set(
910
collapse = TRUE,
1011
message = FALSE,
@@ -53,14 +54,16 @@ geocode cadastral references.
5354
Install **CatastRo** from
5455
[**CRAN**](https://CRAN.R-project.org/package=CatastRo):
5556

56-
```{r, eval = FALSE}
57+
```{r}
58+
#| eval: false
5759
install.packages("CatastRo")
5860
```
5961

6062
You can install the development version of **CatastRo** using the
6163
[r-universe](https://ropenspain.r-universe.dev/CatastRo):
6264

63-
```{r, eval = FALSE}
65+
```{r}
66+
#| eval: false
6467
# Install CatastRo in R:
6568
install.packages("CatastRo",
6669
repos = c(
@@ -72,7 +75,8 @@ install.packages("CatastRo",
7275

7376
Alternatively, you can install the development version of **CatastRo** with:
7477

75-
```{r, eval = FALSE}
78+
```{r}
79+
#| eval: false
7680
remotes::install_github("rOpenSpain/CatastRo", dependencies = TRUE)
7781
```
7882

@@ -82,7 +86,8 @@ The SSL certificate of the Spanish Cadastre presents some issues that may cause
8286
an error when using **CatastRo** (especially on macOS, see issue
8387
[#40](https://github.com/rOpenSpain/CatastRo/issues/40)):
8488

85-
```{r,eval=FALSE}
89+
```{r}
90+
#| eval: false
8691
#> ...(more lines on error)
8792
#>
8893
#> 1: In download.file(url, filepath, quiet = isFALSE(verbose), mode = "wb") :
@@ -95,7 +100,8 @@ an error when using **CatastRo** (especially on macOS, see issue
95100
You can try to fix it by running this line on your session right after you start
96101
using the package:
97102

98-
```{r,eval=FALSE}
103+
```{r}
104+
#| eval: false
99105
options(download.file.method = "curl", download.file.extra = "-k -L")
100106
```
101107

@@ -183,7 +189,9 @@ catr_ovc_get_rccoor(
183189

184190
### Extract geometries using the ATOM service
185191

186-
```{r atom, fig.alt="Extracting buildings in Nava de la Asuncion with the ATOM service"}
192+
```{r}
193+
#| label: atom
194+
#| fig-alt: Extracting buildings in Nava de la Asuncion with the ATOM service
187195
bu <- catr_atom_get_buildings("Nava de la Asuncion", to = "Segovia")
188196
189197
@@ -203,7 +211,9 @@ ggplot(bu) +
203211

204212
### Extract geometries using the WFS service
205213

206-
```{r wfs, fig.alt="Extract Leon Cathedral with the WFS service"}
214+
```{r}
215+
#| label: wfs
216+
#| fig-alt: Extract Leon Cathedral with the WFS service
207217
wfs_get_buildings <- catr_wfs_get_buildings_bbox(
208218
c(-5.569, 42.598, -5.564, 42.601),
209219
srs = 4326
@@ -221,7 +231,8 @@ Some datasets and tiles may have a size larger than 50MB. You can use
221231
**CatastRo** to create your own local repository at a given local directory
222232
passing the following option:
223233

224-
```{r, eval = FALSE}
234+
```{r}
235+
#| eval: false
225236
catr_set_cache_dir("./path/to/location")
226237
```
227238

@@ -230,13 +241,17 @@ load it, speeding up the process.
230241

231242
## Citation
232243

233-
```{r echo=FALSE, results='asis'}
244+
```{r}
245+
#| echo: false
246+
#| results: asis
234247
print(citation("CatastRo"), style = "html")
235248
```
236249

237250
A BibTeX entry for LaTeX users is:
238251

239-
```{r echo=FALSE, comment=''}
252+
```{r}
253+
#| echo: false
254+
#| comment: ''
240255
toBibtex(citation("CatastRo"))
241256
```
242257

codemeta.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@
273273
},
274274
"isPartOf": "https://ropenspain.es/",
275275
"keywords": ["catastro", "cran", "cran-r", "gis", "maps", "r", "r-package", "ropenspain", "rstats", "spain", "spatial", "static-tiles"],
276-
"fileSize": "1378.459KB",
276+
"fileSize": "1356.75KB",
277277
"citation": [
278278
{
279279
"@type": "SoftwareSourceCode",
@@ -299,6 +299,6 @@
299299
],
300300
"releaseNotes": "https://github.com/rOpenSpain/CatastRo/blob/main/NEWS.md",
301301
"readme": "https://github.com/rOpenSpain/CatastRo/blob/main/README.md",
302-
"contIntegration": ["https://github.com/rOpenSpain/CatastRo/actions/workflows/roscron-check-standard.yaml", "https://github.com/rOpenSpain/CatastRo/actions/workflows/rhub.yaml", "https://app.codecov.io/gh/rOpenSpain/CatastRo"],
302+
"contIntegration": ["https://github.com/rOpenSpain/CatastRo/actions/workflows/roscron-check-standard.yml", "https://app.codecov.io/gh/rOpenSpain/CatastRo"],
303303
"developmentStatus": "https://www.repostatus.org/#active"
304304
}

man/figures/README-atom-1.png

-3.95 KB
Loading

man/figures/README-wfs-1.png

-3.03 KB
Loading
-8.37 KB
Binary file not shown.
-12 KB
Binary file not shown.
-15.5 KB
Binary file not shown.
-3.16 KB
Binary file not shown.

0 commit comments

Comments
 (0)