Download and get path to examples files

This function will download all example data from DataTnetRUI project and add them the the TnetRUI package. It will get all files needed for the examples and return all path in a list. License info for the data used is in the details section and can be shown with license = TRUE.

Usage

TNETutils_openExempleData(license = FALSE)

Arguments

license

if TRUE, License information of the data is shown. If false, all example file path are exported.

Value

list with all path to all example data and view licenses informations

Details

J2000 Saône exemple data provided in DataTnetRUI are licensed under CC BY-NC-ND 4.0 and are provided 'AS IS', with no warranties.

SAFRAN exemple data provided in DataTnetRUI are provided by "Météo-France" and are royalty-free under Licence Ouverte d'Etalab

Examples

exempleData <- TNETutils_openExempleData()
print(exempleData)
#> $Shapefile_segments
#> [1] "/tmp/Rtmp2hl65X/temp_libpath9279352bb84f2/TnetRUI/datatnetrui-v1.0/data/TestNetwork_Ardiere.shp"
#> 
#> $Shapefile_nodes
#> [1] "/tmp/Rtmp2hl65X/temp_libpath9279352bb84f2/TnetRUI/datatnetrui-v1.0/data/TestNetwork_ND_Ardiere.shp"
#> 
#> $DEM
#> [1] "/tmp/Rtmp2hl65X/temp_libpath9279352bb84f2/TnetRUI/datatnetrui-v1.0/data/DEM_Ardiere.tif"
#> 
#> $SAFRAN_grid
#> [1] "/tmp/Rtmp2hl65X/temp_libpath9279352bb84f2/TnetRUI/datatnetrui-v1.0/data/SAFRAN_grid_Ardiere.shp"
#> 
#> $SAFRAN_path
#> [1] "/tmp/Rtmp2hl65X/temp_libpath9279352bb84f2/TnetRUI/datatnetrui-v1.0/data/Safran"
#> 
#> $J2K_path
#> [1] "/tmp/Rtmp2hl65X/temp_libpath9279352bb84f2/TnetRUI/datatnetrui-v1.0/data/J2K_Ardiere"
#> 

TNETutils_openExempleData(license = TRUE)
#> ℹ J2000 License:
#> License
#> 
#> Copyright (c) 2024 INRAE Riverly
#> 
#> The data provided in this package, including the J2000 Saône example data, are
#> licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0
#> International License (CC BY-NC-ND 4.0). You may view the full license at:
#> 
#> https://creativecommons.org/licenses/by-nc-nd/4.0/?ref=chooser-v1
#> 
#> Disclaimer
#> 
#> The data are provided "AS IS," without any warranties, express or implied. The
#> authors or providers of this data shall not be held liable for any claims,
#> damages, or other liabilities arising from the use of this data.
#> 
#> ℹ SAFRAN License:
#> SAFRAN data are provided by "Météo-France" and are royalty-free under "Licence
#> Ouverte d'Etalab" detaled here:
#> 
#> https://www.etalab.gouv.fr/wp-content/uploads/2014/05/Licence_Ouverte.pdf