Getting started with tutorials — getting

Guides the user through the various tutorials and assist with downloading the demo data

Usage

getting_started(demo_data = TRUE)

Arguments

demo_data: A boolean object specifying whether to prompt user about downloading the demo data (default is TRUE)

Examples

getting_started()
#> Welcome to VertexWiseR's demo!
#> Before starting, you may want to download the demo_data folder (~218 MB) used by the various tutorials. Would you like to download it now? 
#> 
#> 1: Yes, in a temporary R directory (default path is tempdir())
#> 2: Yes, in the current working directory (C:/Users/charly.billaud/OneDrive - Nanyang Technological University/Desktop/CBHL/VertexwiseR/VertexWiseR/docs/reference)
#> 3: Yes, let me type a path where it will go
#> 4: No
#> 
#> 
#> Download and extraction process completed.
#> 
#> Demo files were saved in: C:\Users\charly.billaud\AppData\Local\Temp\RtmpE7Sxit\demo_data 
#> 
#> Available tutorials (will open in Rstudio's Help panel): 
#> 
#> 1: Extracting surface data in VertexWiseR
#> 2: Example analyses with VertexWiseR - Example 1
#> 3: Example analyses with VertexWiseR - Example 2
#>