Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dieghernan committed Apr 5, 2024
1 parent 80749a8 commit c1b422c
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 49 deletions.
39 changes: 24 additions & 15 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,29 @@ packages](https://www.tidyverse.org/packages/) for objects created with the
`SpatVector`. It also provides `geoms` for plotting these objects with
[**ggplot2**](https://ggplot2.tidyverse.org/).

Please cite **tidyterra** as:

> Hernangómez, D., (2023). Using the tidyverse with terra objects: the tidyterra
> package. *Journal of Open Source Software*, *8*(91), 5751,
> <https://doi.org/10.21105/joss.05751>.
A BibTeX entry for LaTeX users is:

``` bib
@article{Hernangómez2023,
doi = {10.21105/joss.05751},
url = {https://doi.org/10.21105/joss.05751},
year = {2023},
publisher = {The Open Journal},
volume = {8},
number = {91},
pages = {5751},
author = {Diego Hernangómez},
title = {Using the {tidyverse} with {terra} objects: the {tidyterra} package},
journal = {Journal of Open Source Software}
}
```

## Overview

Full manual of the most recent release of **tidyterra** on **CRAN** is online:
Expand Down Expand Up @@ -97,7 +120,7 @@ example, `as_tibble()` would return a `tibble`).
Current methods and functions provided by **tidyterra** are:

| tidyverse method | `SpatVector` | `SpatRaster` |
|---------------------|---------------------|---------------------------------------|
|---------------------|---------------------|--------------------------------------|
| `tibble::as_tibble()` | ✔️ | ✔️ |
| `dplyr::select()` | ✔️ | ✔️ Select layers |
| `dplyr::mutate()` | ✔️ | ✔️ Create /modify layers |
Expand Down Expand Up @@ -311,20 +334,6 @@ open a new [issue](https://github.com/dieghernan/tidyterra/issues)!
You can also ask in [Stack Overflow](https://stackoverflow.com/) using the tag
[[tidyterra]](https://stackoverflow.com/questions/tagged/tidyterra).

## Citation

If you use this software, please cite our article in the [Journal of Open Source
Software](https://joss.theoj.org/):

> Hernangómez, D., (2023). Using the tidyverse with terra objects: the tidyterra
> package. *Journal of Open Source Software*, *8*(91), 5751,
> <https://doi.org/10.21105/joss.05751>.
A BibTeX entry for LaTeX users is:

```{r echo=FALSE, comment=""}
toBibtex(citation("tidyterra"))
```

## Acknowledgement

Expand Down
48 changes: 23 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,29 @@ objects created with the
`SpatRaster` and `SpatVector`. It also provides `geoms` for plotting
these objects with [**ggplot2**](https://ggplot2.tidyverse.org/).

Please cite **tidyterra** as:

> Hernangómez, D., (2023). Using the tidyverse with terra objects: the
> tidyterra package. *Journal of Open Source Software*, *8*(91), 5751,
> <https://doi.org/10.21105/joss.05751>.
A BibTeX entry for LaTeX users is:

``` bib
@article{Hernangómez2023,
doi = {10.21105/joss.05751},
url = {https://doi.org/10.21105/joss.05751},
year = {2023},
publisher = {The Open Journal},
volume = {8},
number = {91},
pages = {5751},
author = {Diego Hernangómez},
title = {Using the {tidyverse} with {terra} objects: the {tidyterra} package},
journal = {Journal of Open Source Software}
}
```

## Overview

Full manual of the most recent release of **tidyterra** on **CRAN** is
Expand Down Expand Up @@ -329,31 +352,6 @@ You can also ask in [Stack Overflow](https://stackoverflow.com/) using
the tag
[\[tidyterra\]](https://stackoverflow.com/questions/tagged/tidyterra).

## Citation

If you use this software, please cite our article in the [Journal of
Open Source Software](https://joss.theoj.org/):

> Hernangómez, D., (2023). Using the tidyverse with terra objects: the
> tidyterra package. *Journal of Open Source Software*, *8*(91), 5751,
> <https://doi.org/10.21105/joss.05751>.
A BibTeX entry for LaTeX users is:

@Article{R-tidyterra,
title = {Using the {tidyverse} with {terra} objects: the {tidyterra} package},
doi = {10.21105/joss.05751},
author = {Diego Hernangómez},
year = {2023},
url = {https://doi.org/10.21105/joss.05751},
publisher = {The Open Journal},
volume = {8},
number = {91},
pages = {5751},
journal = {Journal of Open Source Software},
issn = {2475-9066},
}

## Acknowledgement

**tidyterra** **ggplot2** geoms are based on
Expand Down
3 changes: 1 addition & 2 deletions vignettes/articles/INPUBS.bib
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,6 @@ @book{mrazek2024drahe
year = 2024,
publisher = {Masarykova univerzita},
address = {Brno},
isbn = 978-80-280-0354-8,
edition = {First}
isbn = {978-80-280-0354-8}
}

11 changes: 4 additions & 7 deletions vignettes/articles/faqs.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,9 @@ previous questions in the following links.
You can also ask in [Stack Overflow](https://stackoverflow.com/) using the tag
[`tidyterra`](https://stackoverflow.com/questions/tagged/tidyterra).

```{r issues, echo=FALSE, results='asis'}
link <- unlist(packageDescription("tidyterra")["BugReports"])
cat("\n- Issues: ", link)
dis <- gsub("issues$", "discussions", link)
cat("\n- Discussions: ", dis)
cat("\n")
```
- Report a Bug [[link](https://github.com/dieghernan/tidyterra/issues)].
- Ask a question
[[link](https://github.com/dieghernan/tidyterra/discussions)].

## `NA` values are shown in gray color {#nas-remove}

Expand Down Expand Up @@ -668,3 +664,4 @@ sessioninfo::session_info()
```

</details>

0 comments on commit c1b422c

Please sign in to comment.