diff --git a/docs/img/massive-ca/MassIVE-CA_access_request_input_form.png b/docs/img/massive-ca/MassIVE-CA_access_request_input_form.png new file mode 100644 index 0000000..1a8d905 Binary files /dev/null and b/docs/img/massive-ca/MassIVE-CA_access_request_input_form.png differ diff --git a/docs/img/massive-ca/MassIVE-CA_approved_access_request.png b/docs/img/massive-ca/MassIVE-CA_approved_access_request.png new file mode 100644 index 0000000..d5f7cbb Binary files /dev/null and b/docs/img/massive-ca/MassIVE-CA_approved_access_request.png differ diff --git a/docs/img/massive-ca/MassIVE-CA_pending_access_request.png b/docs/img/massive-ca/MassIVE-CA_pending_access_request.png new file mode 100644 index 0000000..6eca7bd Binary files /dev/null and b/docs/img/massive-ca/MassIVE-CA_pending_access_request.png differ diff --git a/docs/img/massive-ca/MassIVE-CA_pending_access_requests.png b/docs/img/massive-ca/MassIVE-CA_pending_access_requests.png new file mode 100644 index 0000000..2c45d17 Binary files /dev/null and b/docs/img/massive-ca/MassIVE-CA_pending_access_requests.png differ diff --git a/docs/img/massive-ca/MassIVE-CA_splash_access_request.png b/docs/img/massive-ca/MassIVE-CA_splash_access_request.png new file mode 100644 index 0000000..0311a8d Binary files /dev/null and b/docs/img/massive-ca/MassIVE-CA_splash_access_request.png differ diff --git a/docs/img/massive-ca/MassIVE-CA_splash_view_access_requests.png b/docs/img/massive-ca/MassIVE-CA_splash_view_access_requests.png new file mode 100644 index 0000000..2d3c1a2 Binary files /dev/null and b/docs/img/massive-ca/MassIVE-CA_splash_view_access_requests.png differ diff --git a/docs/img/massive-ca/MassIVE-CA_submission_input_form.png b/docs/img/massive-ca/MassIVE-CA_submission_input_form.png index 07f7e90..8eeb368 100644 Binary files a/docs/img/massive-ca/MassIVE-CA_submission_input_form.png and b/docs/img/massive-ca/MassIVE-CA_submission_input_form.png differ diff --git a/docs/img/massive-ca/MassIVE-CA_workflow_selection_access_request.png b/docs/img/massive-ca/MassIVE-CA_workflow_selection_access_request.png new file mode 100644 index 0000000..e6ee96e Binary files /dev/null and b/docs/img/massive-ca/MassIVE-CA_workflow_selection_access_request.png differ diff --git a/docs/massive-ca/access_data.md b/docs/massive-ca/access_data.md index 292c091..0b8fb70 100644 --- a/docs/massive-ca/access_data.md +++ b/docs/massive-ca/access_data.md @@ -1 +1,54 @@ -MassIVE-CA dataset access documentation coming soon +To download and reanalyze a controlled access dataset in MassIVE-CA, first navigate to the official MassIVE-CA repository web site - [https://massive-access.ucsd.edu/](https://massive-access.ucsd.edu/). You will then need to log in to your registered MassIVE-CA account. + +> **NOTE** +> MassIVE-CA accounts are separate from the main MassIVE system. You will need to create a new MassIVE-CA account to begin the submission process. + +> **NOTE** +> Coming soon: Integrated NIH Researcher Authentication Service (RAS) authentication. This implements strict identity proofing by requiring all MassIVE-CA users to have a valid eRA Commons account. + +## Access Request + +![MassIVE-CA_splash_access_request](../img/massive-ca/MassIVE-CA_splash_access_request.png) + +Once logged in, click on "Request access" under "Request Access to Controlled Access Dataset" to load the MassIVE-CA access request input form. There are a number of useful workflows available on this page, but to request access to a dataset, just be sure that the "MassIVE Controlled Access Dataset Access Request" workflow is highlighted in the "Workflow" drop-down menu near the top of the page. + +![MassIVE-CA_workflow_selection_access_request](../img/massive-ca/MassIVE-CA_workflow_selection_access_request.png) + +With this workflow selected, you will see an input form including all file and metadata fields relevant to your request. + +![MassIVE-CA_access_request_input_form](../img/massive-ca/MassIVE-CA_access_request_input_form.png) + +> **NOTE** +> Don't forget to enter a non-empty password, and be sure to write it down! This is the password you will use to log in to the MassIVE-CA FTP server to download the protected dataset files after your access request is approved. This password is not stored in plain text anywhere in the MassIVE-CA system, so we will not be able to share it with you after you leave this page! + +> **NOTE** +> Coming soon: A formal Data Usage Agreement (DUA) outlining your responsibilities and expectations as a downloader of controlled access data from MassIVE-CA. This document is currently in the draft process; see the latest revision [here](https://docs.google.com/document/d/1wtVB28OuJfn3FwoQvy9JZYtB2CPN9FRTTGTturaQNVU/edit?usp=sharing), and please submit any questions or comments you may have. + +When you are ready to submit your dataset access request, click on the "Submit" button at the bottom of the form, and your request will be sent to the MassIVE-CA web server for validation. + +![MassIVE-CA_request_submission](../img/submission_workflow/MassIVE_dataset_submission.png) + +### Access Request Review + +After you submit your request, a qualified MassIVE-CA reviewer will be automatically notified, and will conduct a thorough review in a timely manner. You can check the current status of your request by logging in and clicking "View all your pending access requests" on the MassIVE-CA splash page. + +![MassIVE-CA_splash_view_access_requests](../img/massive-ca/MassIVE-CA_splash_view_access_requests.png) + +This takes you to your MassIVE-CA dataset request dashboard, automatically filtered to show only pending dataset access requests. + +![MassIVE-CA_pending_access_requests](../img/massive-ca/MassIVE-CA_pending_access_requests.png) + +Click "Review" to view the current status of your pending request. + +![MassIVE-CA_pending_access_request](../img/massive-ca/MassIVE-CA_pending_access_request.png) + +### Approved Access + +Once your request has been thoroughly reviewed, you will be automatically notified of the final outcome. If your request was approved, then the request page updates to reflect the new status, and FTP download instructions are displayed. + +![MassIVE-CA_approved_access_request](../img/massive-ca/MassIVE-CA_approved_access_request.png) + +At this point, a special FTP account is automatically created for you to log in to the MassIVE-CA FTP server (**massive-ca-ftp.ucsd.edu**) to download the files associated with your dataset of interest. See our [FTP upload documentation](https://ccms-ucsd.github.io/MassIVEDocumentation/#upload_data/) for more information on the process of setting up an FTP client and connecting to the FTP server (although be sure to use the proper FTP host name for this controlled access download). + +> **NOTE** +> This repository and web portal are still a work in progress. If you encounter any difficulties, or simply have questions or comments you'd like to share, please feel free to contact us at [massive@ucsd.edu](mailto:massive@ucsd.edu). diff --git a/docs/massive-ca/submit_data.md b/docs/massive-ca/submit_data.md index 1954ce2..82cb7d0 100644 --- a/docs/massive-ca/submit_data.md +++ b/docs/massive-ca/submit_data.md @@ -8,13 +8,13 @@ To submit a controlled access dataset to MassIVE-CA, first navigate to the offic ## Submission Request -![MassIVE-CA_splash_submission](../img/massive-ca/MassIVE-CA_splash_submission_request.png) +![MassIVE-CA_splash_submission_request](../img/massive-ca/MassIVE-CA_splash_submission_request.png) -Once logged in, click on "Submit a request" under "Request New Controlled Access Dataset" to load the MassIVE-CA submission request input page. There are a number of useful workflows available on this page, but to submit a dataset, just be sure that the "MassIVE Controlled Access Dataset Submission Request" workflow is highlighted in the "Workflow" drop-down menu near the top of the page. +Once logged in, click on "Submit a request" under "Request New Controlled Access Dataset" to load the MassIVE-CA submission request input form. There are a number of useful workflows available on this page, but to submit a dataset, just be sure that the "MassIVE Controlled Access Dataset Submission Request" workflow is highlighted in the "Workflow" drop-down menu near the top of the page. -![MassIVE-CA_workflow_selection](../img/massive-ca/MassIVE-CA_workflow_selection_submission_request.png) +![MassIVE-CA_workflow_selection_submission_request](../img/massive-ca/MassIVE-CA_workflow_selection_submission_request.png) -With this workflow selected, you will see an input form including all file and metadata fields relevant to your submission. +With this workflow selected, you will see an input form including all file and metadata fields relevant to your request. ![MassIVE-CA_submission_request_input_form](../img/massive-ca/MassIVE-CA_submission_request_input_form.png) @@ -24,9 +24,9 @@ With this workflow selected, you will see an input form including all file and m > **NOTE** > Coming soon: A formal Data Processing Agreement (DPA) outlining your responsibilities and expectations as a submitter of controlled access data to MassIVE-CA. This document is currently in the draft process; see the latest revision [here](https://docs.google.com/document/d/1PyhrcWkvBdz5NnqlXlBXL1fW4fZt2NEdTa9YW1_tu5M/edit?usp=sharing), and please submit any questions or comments you may have. -When you are ready to submit your dataset submission request, click on the "Submit" button at the bottom of the form, and your request will be sent to the MassIVE web server for validation. +When you are ready to submit your dataset submission request, click on the "Submit" button at the bottom of the form, and your request will be sent to the MassIVE-CA web server for validation. -![MassIVE_dataset_submission](../img/submission_workflow/MassIVE_dataset_submission.png) +![MassIVE-CA_request_submission](../img/submission_workflow/MassIVE_dataset_submission.png) ### Submission Request Review @@ -38,7 +38,7 @@ This takes you to your MassIVE-CA dataset request dashboard, automatically filte ![MassIVE-CA_pending_submission_requests](../img/massive-ca/MassIVE-CA_pending_submission_requests.png) -Click "Review" to view the current status of your pending review. +Click "Review" to view the current status of your pending request. ![MassIVE-CA_pending_submission_request](../img/massive-ca/MassIVE-CA_pending_submission_request.png)