Skip to content

Commit

Permalink
doc: edit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ahasverus committed Feb 23, 2024
1 parent 95520b3 commit bf844ea
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
1 change: 1 addition & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ For an overview of the main features of `forcis`, please read the [Get started](
## Long-form documentations

`forcis` provides five vignettes to learn more about the package:

- the [Get started](https://frbcesab.github.io/forcis/articles/forcis.html) vignette describes the core features of the package
- the [Database versions](https://frbcesab.github.io/forcis/articles/database-versions.html) vignette provides information on how to deal with the versioning of the database
- the [Select and filter data](https://frbcesab.github.io/forcis/articles/select-and-filter-data.html) vignette shows examples to handle the FORCIS data
Expand Down
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,19 +77,25 @@ vignette.

## Long-form documentations

`forcis` provides five vignettes to learn more about the package: - the
[Get started](https://frbcesab.github.io/forcis/articles/forcis.html)
vignette describes the core features of the package - the [Database
versions](https://frbcesab.github.io/forcis/articles/database-versions.html)
vignette provides information on how to deal with the versioning of the
database - the [Select and filter
data](https://frbcesab.github.io/forcis/articles/select-and-filter-data.html)
vignette shows examples to handle the FORCIS data - the [Data
conversion](https://frbcesab.github.io/forcis/articles/data-conversion.html)
vignette describes the conversion functions available in `forcis` to
compute abundances, concentrations, and frequencies - the [Data
visualization](https://frbcesab.github.io/forcis/articles/data-visualization.html)
vignette describes the plotting functions available in `forcis`
`forcis` provides five vignettes to learn more about the package:

- the [Get
started](https://frbcesab.github.io/forcis/articles/forcis.html)
vignette describes the core features of the package
- the [Database
versions](https://frbcesab.github.io/forcis/articles/database-versions.html)
vignette provides information on how to deal with the versioning of
the database
- the [Select and filter
data](https://frbcesab.github.io/forcis/articles/select-and-filter-data.html)
vignette shows examples to handle the FORCIS data
- the [Data
conversion](https://frbcesab.github.io/forcis/articles/data-conversion.html)
vignette describes the conversion functions available in `forcis` to
compute abundances, concentrations, and frequencies
- the [Data
visualization](https://frbcesab.github.io/forcis/articles/data-visualization.html)
vignette describes the plotting functions available in `forcis`

## Citation

Expand Down

0 comments on commit bf844ea

Please sign in to comment.