From b65fd36496c92a2e66a0bae3a0b45a97091d1f5f Mon Sep 17 00:00:00 2001 From: Ketsia Guichard Date: Wed, 22 May 2024 15:31:20 +0200 Subject: [PATCH] update references for CRAN --- README.md | 25 +- docs/404.html | 2 +- docs/LICENSE-text.html | 2 +- docs/articles/data-details.html | 2 +- docs/articles/data-visualization.html | 687 ++++++++++++++++++ .../figure-html/unnamed-chunk-10-1.png | Bin 0 -> 112072 bytes .../figure-html/unnamed-chunk-11-1.png | Bin 0 -> 95946 bytes .../figure-html/unnamed-chunk-12-1.png | Bin 0 -> 94470 bytes .../figure-html/unnamed-chunk-13-1.png | Bin 0 -> 79572 bytes .../figure-html/unnamed-chunk-14-1.png | Bin 0 -> 91252 bytes .../figure-html/unnamed-chunk-15-1.png | Bin 0 -> 72800 bytes .../figure-html/unnamed-chunk-16-1.png | Bin 0 -> 72536 bytes .../figure-html/unnamed-chunk-17-1.png | Bin 0 -> 82699 bytes .../figure-html/unnamed-chunk-18-1.png | Bin 0 -> 119613 bytes .../figure-html/unnamed-chunk-4-1.png | Bin 0 -> 66982 bytes .../figure-html/unnamed-chunk-5-1.png | Bin 0 -> 153795 bytes .../figure-html/unnamed-chunk-6-1.png | Bin 0 -> 108889 bytes .../figure-html/unnamed-chunk-7-1.png | Bin 0 -> 169258 bytes .../figure-html/unnamed-chunk-8-1.png | Bin 0 -> 99893 bytes .../figure-html/unnamed-chunk-9-1.png | Bin 0 -> 108856 bytes docs/articles/index.html | 4 +- docs/authors.html | 2 +- docs/index.html | 20 +- docs/news/index.html | 2 +- docs/pkgdown.yml | 4 +- docs/reference/check_options_graph.html | 2 +- docs/reference/convert_string_to_list.html | 2 +- docs/reference/create_config.html | 2 +- docs/reference/enrich_dates.html | 2 +- docs/reference/enrich_name.html | 2 +- docs/reference/enrich_special_days.html | 2 +- docs/reference/enrich_traffic.html | 2 +- docs/reference/enrich_uptime.html | 2 +- docs/reference/filter_agg.html | 2 +- docs/reference/get_api_state.html | 2 +- docs/reference/get_custom_palette.html | 2 +- docs/reference/get_graph_subtitles.html | 2 +- docs/reference/get_segment_name.html | 2 +- docs/reference/get_segments.html | 2 +- docs/reference/get_telraam_token.html | 2 +- docs/reference/gg_availability.html | 2 +- docs/reference/gg_car_speed_histogram.html | 2 +- docs/reference/gg_car_speed_v85.html | 2 +- docs/reference/gg_traffic_avg.html | 2 +- docs/reference/gg_traffic_evolution.html | 2 +- docs/reference/import_sensor.html | 2 +- docs/reference/index.html | 2 +- docs/reference/is_vacation.html | 2 +- docs/reference/melt_direction_mode.html | 2 +- docs/reference/preprocess_car_speed.html | 2 +- docs/reference/retrieve_sensor.html | 2 +- docs/reference/seq_by_3_month.html | 2 +- docs/reference/set_global_vars.html | 2 +- docs/reference/set_telraam_token.html | 2 +- docs/reference/traffic.html | 2 +- docs/reference/write_update_data.html | 2 +- docs/search.json | 1 + docs/sitemap.xml | 3 + ...sualization.Rmd => data-visualization.Rmd} | 0 59 files changed, 742 insertions(+), 74 deletions(-) create mode 100644 docs/articles/data-visualization.html create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-10-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-11-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-12-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-13-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-14-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-15-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-16-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-17-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-18-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-4-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-5-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-6-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-7-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-8-1.png create mode 100644 docs/articles/data-visualization_files/figure-html/unnamed-chunk-9-1.png create mode 100644 docs/search.json rename vignettes/{data_visualization.Rmd => data-visualization.Rmd} (100%) diff --git a/README.md b/README.md index c511675..24c0f79 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/docs/404.html b/docs/404.html index 4bbf966..51bcc10 100644 --- a/docs/404.html +++ b/docs/404.html @@ -40,7 +40,7 @@