Skip to content

Commit

Permalink
add sheet delete docs (#1688, #1698)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikkonie committed Aug 8, 2023
1 parent e24d55d commit 822aa6c
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
61 changes: 61 additions & 0 deletions docs_manual/source/app_samplesheets_delete.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
.. _app_samplesheets_delete:

Deleting Sample Sheets
^^^^^^^^^^^^^^^^^^^^^^

To delete sample sheets from a project, open the :guilabel:`Sheet Operations`
dropdown and select :guilabel:`Delete Sheets`. If iRODS collections have been
created for the project, this dropdown item will appear as
:guilabel:`Delete Sheets and Data`.

.. figure:: _static/app_samplesheets/sheet_ops_no_irods.png
:align: center

Sheet Operations dropdown


Deletion Without iRODS Data
===========================

If no data has been uploaded into iRODS, the sample sheets can be deleted by any
project member with the role of contributor and above. You will be presented
with a confirmation form, in which you have to type the full host name of the
SODAR instance you are working on to initiate deletion.

.. figure:: _static/app_samplesheets/sheet_delete.png
:align: center
:scale: 75%

Sheet deletion confirmation form

.. warning::

This action will delete the sample sheets, related display and editing
configurations and possible previously saved versions. This action can not
be undone!


Deletion With iRODS Data
========================

If files have been uploaded into the project sample data repository via landing
zones, deleting the sample sheets is only allowed for users with the owner or
delegate role. The confirmation form will present a warning regarding the
deletion of iRODS files along with the sample sheets.

.. figure:: _static/app_samplesheets/sheet_delete_data.png
:align: center
:scale: 75%

Sheet deletion confirmation form with iRODS data

If you have contributor access to a project and wish to delete the sheets when
data has been uploaded, you can either request an owner or delegate to handle
deletion, or submit :ref:`app_samplesheets_irods_delete` and delete the sheets
yourself after the requests have been accepted.

.. warning::

In addition to deleting the sample sheets and saved versions, this action
will also delete all project files from iRODS. This action can not be
undone!
1 change: 1 addition & 0 deletions docs_manual/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ Table of Contents
app_samplesheets_version
app_samplesheets_irods_ticket
app_samplesheets_irods_delete
app_samplesheets_delete
app_samplesheets_sync

.. toctree::
Expand Down

0 comments on commit 822aa6c

Please sign in to comment.