Documentation
Last updated
Was this helpful?
Last updated
Was this helpful?
Workflow documentation is viewed and edited from the workflow overview. To access the overview, click the workflow name in the middle of the black menu bar or click on the white space in the background of the workflow tree.
Rename your workflow by clicking the header at the top of the workflow information view. Workflow names will be visible to anywhere this workflow is referenced.
You can add a short description of your workflow here that will be visible in workflow previews across Redivis, including if it is featured on an organization home page.
View and update information about this workflow's creators and contributors, citation, and any related identifiers detected by Redivis automatically or added by a workflow editor. This is also where you can issue a DOI for this workflow.
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.
This section automatically includes anyone who edited this workflow. Workflow editors can add or remove anyone from this list.
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.
This section automatically includes any datasets or workflows referenced by this project, including data sources, study 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.
You can launch a bibliography which displays the citation of this workflow and every related identifier listed above.
Document the details of your research aim or data cleaning strategy. You can also embed links or images.
You can give other users access to view or edit your workflow, or transfer ownership to another user in the Sharing section. You can also set this workflow's visibility and discoverability. Anyone viewing your workflow will need to have gained data access to any restricted datasets to view the relevant node contents.
You can add your workflow to a study in order to facilitate collaboration with others. For certain restricted datasets, your workflow will need to be part of an approved study in order to run queries.
You can add up to 25 tags to your workflow, which will help researchers discover and understand it.
You can see the data of last workflow activity, how often the workflow was forked or viewed (if it is a public workflow).
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.
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 not be issued for workflows that remain fully private.
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.
The dataset overview has additional tabs that list all the nodes in the workflow. You can click on any node in one of these lists to navigate directly to it.
These lists can be filtered by their relative location in the workflow, variables they contain, and additional metrics.
