Skip to content

Help for Project Summary Page

Terry Weymouth edited this page Dec 13, 2018 · 49 revisions

Project Summary page

In the projects index page, when you click on a project title, you will be taken to the Project page. This page shows a list of experiments for the project, and a side-bar menu to navigate through the detail of the project. The initial state of this page might look something like this (shown here using the demo project):

The landing page for a Project

On this page the top is the same as before: the toggles for Projects and Published data, a search interface, the help button, the Report Issue Button, and the user-action pull down menu (which we already encountered in the description of the top level Projects Page).

The left side panel shows the project parts and actions: the Project title (which is a button that will return you to this page), the Project Description, that list of people sharing the project, the Notes/To-dos panel, the Project-Datasets panel, the Experiments list opener (with the number of experiments, the Samples panel, the Files panel, the Settings panel, the Sync button, the Globus Commands, and the Shortcuts list. See the section "Left Side Navigation Bar", below.

Just to review, In the upper left corner of the page, the Materials Commons buttons are used to navigate to the top level pages of the site. Clicking on the 'Projects' link will return you to the top level of the Project management area of the site Projects Index Page. Clicking on the 'Published Data' link will take you to the top level Public Data Page.

Next to the these top level navigation links is the Search interface. To search just type in all or part of an experiment name and hit return. The matching experiments will show in the experiments list. To reset the search, refresh the page.

On the right side of this banner is the User Action pull down menu (which we encountered in the help on the Projects Index Page), and a link to report issues. When you click on the link to report issues, your default mail application should open with a message addressed to help@materialcommons.org. Use this to report any problems that you are having. When you report a problem, please try to be as detail as possible about what you were doing at the time, what went wrong, and what you expected to happen instead. Obviously, if your message says something like "it doesn't work", we can't be of much help.

The '?' icon links you to these help pages.

Left-Side Navigation Bar

The navigation bar, on the left, starts with the name of the project, which is also the "home" button; clicking on it will bring you back to the starting page. In addition, this navigation bar contains the following items:

Project Description

Project Description

Select this item to chance the project description: type a new description and click Save; or click Cancel

Collaborators

Project users list

Select user with whom you wish to share this project. Any user selected becomes a co-author on the project. That person will be able to edit any part of the project and carry out any action on the project that the owner of the project can do (except delete the project; only the owner of the project is able to delete the project).

Notes and To-do items

Project notes and to-do list

Use these interfaces to add note and do-to items to the project. Add to-do items and type the text for the item; delete the item, mark it Done, or check it off the list.

Datasets

A data set is a collections of project experiments, samples, and file, intended for publication. You can create datasets at the Project or Experiment level. Once published, a dataset becomes world readable and appears in the Materials Commons "Published Data" list. A dataset can be un-published and deleted. A published dataset can not be deleted. An unpublished dataset that is not deleted can be republished.

Project datasets

Use this interface to see your list of Project datasets, and select then for editing. When you add a new dataset the Edit panel will appear:

Add project dataset

Experiments

Samples

Project samples list

All Files

Project Directories and Files

Settings and Sync

Project Settings list

Globus Commands

Globus Commands

Shortcuts

Project directory shortcuts

Setting the Project directory shortcuts

Experiments list and actions

This panel contains the selection of experiment state, the experiment actions, and a list of experiments. On at the top of the experiments-list panel field is a set of radio buttons that filter Experiments by activity state. When we look at details panel of the Experiment page, you will see that an Experiment can be in one of three states: Active, Completed, or On Hold. By default, you are viewing only those Experiments that are active. To view Experiments in other states, click the corresponding radio button.

Finally there is the Create New Experiment button which we will cover in the next section.

Create a New Experiment

The 'Start New Experiment' button will do just that. When you click on it, you will see the Create Experiment dialog.

Project page New Experiment dialog

Where you set the name and description of the new experiment. Only the name is required (the description being optional). Any additional values for the Experiment are set in the Experiment page itself, discussed in the section on the Experiment Page. You will also be able, on that page, to edit the Name and description. Clicking Submit on this dialog, takes you directly to the Details Panel of the newly created experiment.

Creating a new experiment also effects the Project summary display. The experiment will be listed in the list of experiments for the project.

Project page with experiment card

Once created, the experiment appears in the "experiment card" display in the Project page (shown directly above). Each card contains a summary of the main attributes of the Experiment description: the title; the description; the date/time the record was last updated; the numbers of Publications, Samples, Processes, Datasets, Files and Notes in the Experiments record; and the Description of the experiment.

Clicking on the Experiment card takes you to the Experiment Page.

Clone this wiki locally