Metadata and provenance

Because workflows are a self-documenting analysis pipeline viewable from any web browser they can be a powerful tool for sharing work in a public forum. Whether you're sharing your work with collaborators or with the world it's helpful to fully document how your your workflow was created and make it clear how it should be properly cited.

Navigate to the workflow overview by clicking on the workflow title in the top bar, or clicking anywhere on the background of the workflow tree in the left pane.

Metadata

Workflows contain supporting information to aid in understanding the analysis performed and provide context for how it was built. A workflow may have some or all of the following metadata provided by its editors:

Abstract	The abstract is limited to 256 characters and will show up in previews and search results for the dataset. This should be a concise, high-level summary of this dataset.
Methodology	Document the details of your research aim or data analysis strategy. You can also embed links or images.
Project	You can add your workflow to a project in order to facilitate collaboration with others. For certain restricted datasets, your workflow will need to be part of an approved project in order to run queries. You can also easily share your workflow with everyone in the project.
Tags	You can add up to 25 tags to your workflow, which will help researchers discover and understand it.
Usage	You can see the data of last workflow activity, how often the workflow was forked or viewed (if it is a public workflow).

Provenance

View and update information about this workflow's creators and contributors, citation, and any related identifiers. Fields are automatically populated based on usage, but can be added or edited by a workflow editor.

Creators	This section automatically defaults to displaying the owner of the project. Workflow editors can add or remove anyone from this list. Anyone included here will be added to the citation generated for this workflow, in the order provided.
Contributor	This section automatically includes anyone who edited this workflow. Workflow editors can add or remove anyone from this list.
Citation	This section shows the automatically generated citation for this workflow in your chosen format. This can be copied or downloaded for use elsewhere. Changes made to the "Creators" field will be reflected in this citation. Any DOI issued for this workflow will automatically be included in this citation.
Related identifiers	This section automatically includes any datasets or workflows referenced by this project, including data sources, project collaboration, or what this workflow was forked from. Workflow editors can add any related identifiers from outside of Redivis through links or DOIs, including DMPs, papers referenced, and more.
Bibliography	You can launch a bibliography which displays the citation of this workflow and all of its related identifiers.

Issue a DOI

Any workflow editor can issue a DOI (Digital Object Identifier) for a workflow. A DOI is a persistent identifier that can be used to reference this workflow in citations. DOIs are issued through DataCite and do not require any configuration with your own or your organization's DataCite account.

Open the Provenance section and click Issue DOI. Once created, you will be able to see the DOI and view the record on DataCite.

Draft status

When DOIs are issued they enter a "Draft" status where the identifier is assigned but it has not been permanently created. All DOIs issued for workflows will remain in this draft status for seven days to allow for removal of the DOI.

You can start referencing the DOI immediately while it is still in draft status since the final DOI will not change once it becomes permanent. After the seven day draft period the DOI will automatically become permanent if your workflow is set to be publicly visible.

Since DOIs are intended for public reference, they will remain in draft status for workflows that are not publicly visible.

Note that granting public access to a workflow does not grant access to any restricted data it contains. Any individual viewing the workflow will need to also gain data access to see workflow nodes that reference restricted data.