Skip to content

Commit

Permalink
doc: setup new vignettes
Browse files Browse the repository at this point in the history
  • Loading branch information
ahasverus committed Feb 12, 2024
1 parent 05363ba commit d58386a
Show file tree
Hide file tree
Showing 5 changed files with 94 additions and 34 deletions.
23 changes: 23 additions & 0 deletions vignettes/data-conversion.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Data conversion"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Data conversion}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
eval = FALSE,
echo = TRUE,
comment = "#>"
)
```

```{r setup}
library(forcis)
```

Work in progress...
23 changes: 23 additions & 0 deletions vignettes/data-filtering.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Data filtering"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Data filtering}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
eval = FALSE,
echo = TRUE,
comment = "#>"
)
```

```{r setup}
library(forcis)
```

Work in progress...
23 changes: 23 additions & 0 deletions vignettes/data-visualization.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Data visualization"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Data visualization}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
eval = FALSE,
echo = TRUE,
comment = "#>"
)
```

```{r setup}
library(forcis)
```

Work in progress...
23 changes: 23 additions & 0 deletions vignettes/database-versions.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Database versions"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Database versions}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
eval = FALSE,
echo = TRUE,
comment = "#>"
)
```

```{r setup}
library(forcis)
```

Work in progress...
36 changes: 2 additions & 34 deletions vignettes/forcis.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,40 +16,8 @@ knitr::opts_chunk$set(
)
```


## Skeleton



```{r setup}
# Setup ----
library("forcis")
library(forcis)
```



```{r 'to-develop'}
# Define the path to store data ----
# path <- here::here()
# Download the latest version of FORCIS database (from Zenodo) ----
get_forcis_db(path = path)
# Import net data ----
nets <- get_plankton_nets_data(path)
# Select taxonomy ----
nets <- select_taxonomy(nets, taxonomy = "OT")
# Select columns ----
nets <- select_columns(nets, cols = NULL)
# Compute concentration ----
nets_concentrations <- compute_concentrations(nets, aggregate = TRUE)
# Compute frequencies ----
nets_frequencies <- compute_frequencies(nets, aggregate = TRUE)
# Compute abundances ----
nets_abundances <- compute_abundances(nets, aggregate = TRUE)
```
Work in progress...

0 comments on commit d58386a

Please sign in to comment.