Skip to content

Commit

Permalink
update references for CRAN
Browse files Browse the repository at this point in the history
  • Loading branch information
KetsiaGuichard committed May 22, 2024
1 parent a6c6c8b commit b65fd36
Show file tree
Hide file tree
Showing 59 changed files with 742 additions and 74 deletions.
25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ The aim of this package is to grant the user tools for data visualisation and da

An example of using this package can be seen in this [`application`](https://agistaterre.shinyapps.io/mov-around/), although it also utilizes more advanced representations.

[`Link to Github repository`](https://github.com/KetsiaGuichard/telraamStats)

This package is currently in a development version, feel free to contact us for more information !
[`Link to Github repository`](https://github.com/agistaterre/telraamStats)

# Telraam Sensors

Expand Down Expand Up @@ -38,28 +36,17 @@ This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 Inter

# Install Package

If you want to install this package from Github, you can use the devtools package:

``` r
if(!require(devtools)){
install.packages("devtools")
}
devtools::install_github("https://github.com/KetsiaGuichard/telraamStats",
dependencies = TRUE,
build_vignettes = TRUE)
install.packages('telraamStats')
library(telraamStats)
```

Vignette (and the entire package) is currently in a development version. If you wish to review the vignette, the `build_vignettes` argument is mandatory.

# Vignettes

Once the package is installed, you can run the following command to view the first vignette :

``` r
vignette("data-details")
```

Or directly read this page : `vignette("data-details")`.
Two vignettes are currently available:
- one explaining the retrieval of Telraam data and describing the data included in the package (`vignette("data-details")`)
- the second detailing the available graphical representations (`vignette("data-visualization")`).

# Future Developments

Expand Down
2 changes: 1 addition & 1 deletion docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/LICENSE-text.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/articles/data-details.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit b65fd36

Please sign in to comment.