Difference between revisions of "CLEX Roadmap"

(Created page with " CLEX Roadmap is a web based tool we provide to help creating, storing and sharing data management plans (DMPs). The original Roadmap has been developed by the ...")
 
Line 1: Line 1:
  
CLEX Roadmap is a web based tool we provide to help creating, storing and sharing data management plans (DMPs). The original Roadmap has been developed by the [http://dcc.ac.uk/ Digital Curation Centre] and the [https://www.cdlib.org/uc3/ University of California Curation Center (UC3)]. Our version has also been adapted to manage allocation of temporary storage in the hh5 NCI project.
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">[[.dmponline.cloud.edu.au|CLEX Roadmap]] is a web based tool we provide to help creating,&nbsp;storing and sharing data management plans (DMPs).&nbsp;The original Roadmap has been developed by the&nbsp;[http://dcc.ac.uk/ Digital Curation Centre]&nbsp;and the&nbsp;[https://www.cdlib.org/uc3/ University of California Curation Center (UC3)]. Our&nbsp;version has also been adapted&nbsp;to manage allocation of temporary storage in /g/data/hh5/tmp at NCI (see [[Storage|storage page]]).</span></span>
  
Creating an account
+
&nbsp;
  
Anyone&nbsp;
+
&nbsp;
  
When you log in to DMPRoadmap you will be directed to the 'My Dashboard' page. From here you can edit, share, download, copy or remove any of your plans. You will also see plans that have been shared with you by others.
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Anyone who is associated to CLEX can have an account, however&nbsp;we do use a valid email list to check that you are authorised. If your email is not in th elist you will receive a warning and we will receive a notification, we will then add your email asap.&nbsp;</span></span>
 +
 
 +
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">When you log in to DMPRoadmap you will be directed to the 'My Dashboard' page. From here you can edit, share, download, copy or remove any of your plans. You will also see plans that have been shared with you by others.</span></span>
 +
 
 +
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">On the navigation tab at the top of the page you can also select to create a new plan, apply for storage or&nbsp;view all your storage allocations.</span></span>
 +
 
 +
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">For more deatils on p</span></span>
  
 
== Create a plan ==
 
== Create a plan ==
Line 12: Line 18:
 
To create a plan, click the 'Create plan' button from the 'My Dashboard' page or the top menu. Select options from the menus and tickboxes to determine what questions and guidance you should be presented with. Confirm your selection by clicking 'Create plan.'
 
To create a plan, click the 'Create plan' button from the 'My Dashboard' page or the top menu. Select options from the menus and tickboxes to determine what questions and guidance you should be presented with. Confirm your selection by clicking 'Create plan.'
  
== Write your plan ==
+
You will now have access to the 'write plan' interface. Currently we only one one available template "CLEX template" so thsi will always be the same.
  
 
The tabbed interface allows you to navigate through different functions when editing your plan.
 
The tabbed interface allows you to navigate through different functions when editing your plan.
Line 18: Line 24:
 
*'Project Details' includes basic administrative details.  
 
*'Project Details' includes basic administrative details.  
 
*'Plan Overview' tells you what template and guidance your plan is based on and gives you an overview to the questions that you will be asked.  
 
*'Plan Overview' tells you what template and guidance your plan is based on and gives you an overview to the questions that you will be asked.  
*The following tab(s) present the questions to answer. There may be more than one tab if your funder or university asks different sets of questions at different stages e.g. at grant application and post-award.  
+
*Collaborators - you can use this add collaborators to your plan, defining their role. Differently from when you share a plan (see below), they do not need to have an account to be listed.
 +
*The following tabs present each a set of questions, we have 3:
 +
**Basic DMP - is a complete DMP&nbsp;in itself. It&nbsp;can be used as an attachment to a grant application
 +
**Provenance - is a set of questions that helps you putting together your data provenance, producing more detailed metadata and keeping track of your data workflow
 +
**Publishing DMP - is to collect details of a complete dataset to help with its publication. The answwers to this questions will be exported create metadata records on the repositories we use to publish. They&nbsp;will also be used to annotate the NetCDF files. This is why some of these have&nbsp;a required&nbsp;format.  
 
*'Share' allows you to invite others to read or contribute to your plan.  
 
*'Share' allows you to invite others to read or contribute to your plan.  
 
*'Download' allows you to download your plan in various formats. This may be useful if you need to submit your plan as part of a grant application.  
 
*'Download' allows you to download your plan in various formats. This may be useful if you need to submit your plan as part of a grant application.  
Line 24: Line 34:
 
When viewing any of the question tabs, you will see the different sections of your plan displayed. Click into these in turn to answer the questions. You can format your responses using the text editing buttons.
 
When viewing any of the question tabs, you will see the different sections of your plan displayed. Click into these in turn to answer the questions. You can format your responses using the text editing buttons.
  
Guidance is displayed in the right-hand panel. If you need more guidance or find there is too much, you can make adjustments on the ‘Project Details’ tab.
+
Guidance is displayed in the right-hand panel. Not all the available guidance shows by default you can show/hide the available guidances by clicking on their headers.
  
 
== Share plans ==
 
== Share plans ==
Line 38: Line 48:
 
By default all new and test plans will be set to ‘Private’ visibility. ‘Public’ and ‘Organisational’ visibility are intended for finished plans. You must answer at least 50% of the questions to enable these options.
 
By default all new and test plans will be set to ‘Private’ visibility. ‘Public’ and ‘Organisational’ visibility are intended for finished plans. You must answer at least 50% of the questions to enable these options.
  
== Request feedback ==
+
NB. to share with a&nbsp;collaborator they also need to have an account, you then share with the email they use for it.&nbsp;
 
 
There may also be an option to request feedback on your plan. This is available when research support staff at your organisation have enabled this service. Click to ‘Request feedback’ and your local administrators will be alerted to your request. Their comments will be visible in the ‘Comments’ field adjacent to each question. You will be notified by email when an administrator provides feedback.
 
 
 
== Download plans ==
 
  
From here you can download your plan in various formats. This may be useful if you need to submit your plan as part of a grant application. Choose what format you would like to view/download your plan in and click to download. You can also adjust the formatting (font type, size and margins) for PDF files, which may be helpful if working to page limits.</p>
+
&nbsp;

Revision as of 01:54, 15 July 2021

CLEX Roadmap is a web based tool we provide to help creating, storing and sharing data management plans (DMPs). The original Roadmap has been developed by the Digital Curation Centre and the University of California Curation Center (UC3). Our version has also been adapted to manage allocation of temporary storage in /g/data/hh5/tmp at NCI (see storage page).

 

 

Anyone who is associated to CLEX can have an account, however we do use a valid email list to check that you are authorised. If your email is not in th elist you will receive a warning and we will receive a notification, we will then add your email asap. 

When you log in to DMPRoadmap you will be directed to the 'My Dashboard' page. From here you can edit, share, download, copy or remove any of your plans. You will also see plans that have been shared with you by others.

On the navigation tab at the top of the page you can also select to create a new plan, apply for storage or view all your storage allocations.

For more deatils on p

Create a plan

To create a plan, click the 'Create plan' button from the 'My Dashboard' page or the top menu. Select options from the menus and tickboxes to determine what questions and guidance you should be presented with. Confirm your selection by clicking 'Create plan.'

You will now have access to the 'write plan' interface. Currently we only one one available template "CLEX template" so thsi will always be the same.

The tabbed interface allows you to navigate through different functions when editing your plan.

  • 'Project Details' includes basic administrative details.
  • 'Plan Overview' tells you what template and guidance your plan is based on and gives you an overview to the questions that you will be asked.
  • Collaborators - you can use this add collaborators to your plan, defining their role. Differently from when you share a plan (see below), they do not need to have an account to be listed.
  • The following tabs present each a set of questions, we have 3:
    • Basic DMP - is a complete DMP in itself. It can be used as an attachment to a grant application
    • Provenance - is a set of questions that helps you putting together your data provenance, producing more detailed metadata and keeping track of your data workflow
    • Publishing DMP - is to collect details of a complete dataset to help with its publication. The answwers to this questions will be exported create metadata records on the repositories we use to publish. They will also be used to annotate the NetCDF files. This is why some of these have a required format.
  • 'Share' allows you to invite others to read or contribute to your plan.
  • 'Download' allows you to download your plan in various formats. This may be useful if you need to submit your plan as part of a grant application.

When viewing any of the question tabs, you will see the different sections of your plan displayed. Click into these in turn to answer the questions. You can format your responses using the text editing buttons.

Guidance is displayed in the right-hand panel. Not all the available guidance shows by default you can show/hide the available guidances by clicking on their headers.

Share plans

Insert the email address of any collaborators you would like to invite to read or edit your plan. Set the level of permissions you would like to grant them via the radio buttons and click to 'Add collaborator.' Adjust permissions or remove collaborators at any time via the drop-down options.

The ‘Share’ tab is also where you can set your plan visibility.

  • Private: restricted to you and your collaborators.
  • Organisational: anyone at your organisation can view your plan.
  • Public: anyone can view your plan in the Public DMPs list.

By default all new and test plans will be set to ‘Private’ visibility. ‘Public’ and ‘Organisational’ visibility are intended for finished plans. You must answer at least 50% of the questions to enable these options.

NB. to share with a collaborator they also need to have an account, you then share with the email they use for it.