Read builtin project

Source: R/fct_read_builtin_project.R

Read a project from disk.

read_builtin_project(path, parameters)

Arguments

path

character file path for the project YAML metadata file.
parameters

list object to interpret spreadsheet data.

Value

A list containing the following elements:

name

A character value indicating the name.

author_name

A character indicating the author name for the data.

author_email

A character indicating the contact email for the data.

project

A Project object.

Examples

# specify file path
f1 <- system.file(
  "extdata", "projects", "simulated-data", "simulated-data.yaml",
  package = "whattodo"
)

# read project
x <- read_builtin_project(f1, whatdataio::read_data_configuration())

# print project
print(x)
#> $name
#> [1] "Simulated dataset"
#> 
#> $author_name
#> [1] "Richard Schuster"
#> 
#> $author_email
#> [1] "richard.schuster@natureconservancy.ca"
#> 
#> $project
#> Project
#>   id:       f534be3d-bbb0-4fc2-b67b-64ca7ca39271
#>   sites:    "Johnston's Pond", "Lobster Bay", "Port Joli", "Round Bay"
#>   features: "Salt Marsh", "ACPF", "Freshwater Wetland"
#>   actions:  "Maintain", "Signage", "Restore"
#>   geometry: TRUE
#>