pkgdown/analytics.html

Skip to contents

Create a GeoPressureTemplate Project

Source: R/create_geopressuretemplate.R
create_geopressuretemplate.Rd

Clone the GeoPressureTemplate project skeleton into path and optionally populate it from a GeoLocator Data Package. When pkg is supplied, the generated project metadata and data files are derived from the package.

Usage

create_geopressuretemplate(path, pkg = NULL, open = interactive())

Arguments

path

Destination directory for the new project. The last path component is used as the project name.

pkg

Optional geolocatordp object used to fill project metadata, config, and data files.

open

If TRUE, the package is opened in a new RStudio session.

Value

The path to the created project directory.

Details

The destination directory must not already contain files. The template is cloned from the GeoPressureTemplate GitHub repository, so both git and network access are required.

When pkg is provided, the function attempts to generate:

  • a DESCRIPTION file;

  • a project README;

  • license files;

  • data files under data/;

  • and config.yml.

Failures in these optional generation steps are reported as warnings and do not abort the project creation.

See also

read_geopressuretemplate() to read a GeoPressureTemplate project back into a GeoLocator Data Package.