publish: Publish a Disco Engine single

View source: R/publishing.R

publishR Documentation

Publish a Disco Engine single

Description

Publishing a definition created in the Discovery Engine makes it easier to share it with other users and helps build standards around constituency definitions. Publish your own definitions (or "singles") using the publish function, and view all singles that have already been published using show_singles().

Usage

publish(single, ...)

## S3 method for class 'disco_single'
publish(single, ...)

## S3 method for class 'listbuilder'
publish(single, ...)

Arguments

single

The definition to be published

...

Can be used to specify metadata. You can leave this blank and follow the interactive prompts.

Details

Publishing requires you to supply some metadata that will make it easier for others to find your single when they need it (things like author's name, description, and keywords). When you use publish, you'll be prompted to enter each item of metadata, so read and follow the prompts.

See Also

show_singles to view existing singles, check_out to check out a published single.

Examples

## Not run: 
## Start by creating a definition
band_member = participated_in(MSMB)

## then just use the publish function and answer the prompts
publish(band_member)

## End(Not run)


tarakc02/discoveryengine documentation built on Sept. 26, 2023, 12:17 a.m.