The goal of the dataspice package is to make it easier for researchers to create basic, lightweight, and concise metadata files for their datasets. These basic files can then be used to:

The dataspice metadata fields are based on and and other, richer metadata standards such as Ecological Metadata Language.

Step 1 - Start with one or more data files

To start the user will have one or more datafiles in a common directory. We currently support rectagular data with headers in a .csv file or spatial data with attributes.

Step 2 - Fill in Templates

create_spice() reads in the files from that directory and creates a set of template metadata files for the user to populate. These metadata templates will include some data extracted from the user's datafiles, including things like file names and measured variable names to aid the user in populating the metadata files.

Once these are created, the user needs to open each template, fill in the missing metadata (as completely as possible), and read the files back into R.

Metadata Files

Step 3 - Save metadata in JSON

Once the populated the metadata files are read back R they can then be fed into write_JSON(), which converts those tabular metadata files into JSON files.

Step 4 - Create a dataspice website

A dataset README website is an interactive representation of the JSON information about the data. Assuming sufficient information is provided in the JSON it will include a map of the points and a bounding box of the area of study.

The output from write_JSON() is fed into build_site() to create the website.

serve_site() ?