Filters and Sorting
Cryo-EM data processing can become complex quickly. A large number of jobs, workspaces, and projects will be created in typical use. It therefore becomes very important to be able to filter and sort through items in CryoSPARC.
When browsing CryoSPARC, the filter and sorting options are displayed in the control bar at the top of the main content area:
Quick filter buttons help quickly filter the displayed items.
- Starred: This button will toggle on the starred filter causing only starred items to be shown. This allows you to quickly locate the your important projects, workspaces, sessions, or jobs.
- Mine: This filter will show only items created by you when toggled on. This can be useful if you are an admin user, or simply to filter out items shared with you to find your own data quickly and easily.
- Tags: This filter will show all applicable tags with the granularity tags (eg. project or workspace specific tags) shown first, and general tags shown before. The numbers on the right side of each tag entry represent the number of items in the instance that have that tag applied.
- Status: The session status filter allows you to filter all sessions by running, completed, or paused. These filters are additive and adding more will show jobs of all selected status types.
- Status: The job status filter allows you to filter jobs by any available status, or combination of statuses. These include: Building, Queued, Launched, Started, Waiting, Running, Killed, Completed, and/or Failed.
The filter bar is where more advanced filter compositions can be created and managed. It contains all possible filter options. In order to access the filter bar, you must click the “Filters” button on the control bar to open the underslung module.
The filter bar is a powerful system for adding, composing, and managing filters. The filter bar has separate filter options relevant to the type of item being filtered.
Filters that you apply are stored in the browser URL bar. This means that you can bookmark or copy the URL from the browser and return to any filtered view that you have created. You can also share the URL with other users who have access to the same projects, and they will see the same filtered view that you have created.
The filter bar is composed of three parts: the filter button, input, and clear button. Clicking the filter button or in input area will open the filter options menu. In the input area, you can also type a word or phrase in order to quickly chose an attribute by which to filter. The clear button allows you to clear all of the filters in the bar in one action, reseting the filter state and showing all available items in the view below.
After opening the filter options menu, you can enter the menu by moving the cursor over it or pressing the down arrow on your keyboard.
There are three classes of filters: singular, compound, and toggle filters. Singular filters such as user filters have multiple options, but can only have one option active at a time. Compound filters such as tags, job type, or status, allow you to select multiple options and will additively filter results (eg. adding multiple status filter options, such as building, queued, and completed, will show all jobs that have any of those statuses).
Let’s begin by adding a building job status filter to see the resulting filter bar composition. After selecting the building status, the menu will remain open in order to allow you to add other status filters more easily. Click outside of the menu or press the escape key to close it.
Now that the filter has been added, it will appear in the input section of the filter bar. The light grey grouping indicator on the lefthand side of the filter tag shows the type of the filter added, in this case “Status”. The coloured filter tag on the righthand side shows the filter option that has been added, in this case “building”. By hovering over the filter tag a small red “X” indicator will show up on the top left corner of the tag, when clicked this will clear that particular filter option. Alternatively, hovering the grey filter grouping indicator on the lefthand side will also show a red “X” indicator on its top left corner, clicking this will clear all filters within that group.
Reopen the filter menu by clicking on the filter bar input section again (anywhere to the right of the currently existing tags). Add the status “killed” from the statuses submenu. This will add a second filter option to the statuses grouping.
Now all jobs shown will either be in building status or killed status. Additional filters from different groupings can be added, such as a date filter, or job type filter, to further isolate results.
Filters can be added and removed to compose a variety of specific views allowing you to find jobs quickly and easily, or compose sets of results outside of the constraints of project or workspace groupings. This can be especially powerful when adding tags or starred filters, which operate as higher level selection groupings similar to upper level granularity groupings but with more flexibility.
Sorting options are located in the sort toggle button on the control bar beside the filter button. The sort button is composed of two parts, the sort order toggle on the lefthand side allows you to toggle ascending or descending order, and the sort option menu on the righthand side allows you to select what option you would like to sort by. By default, items are sorted by the “Date created” option. Projects and workspaces are sorted by default in descending order (showing the newest items at the top), while jobs are sorted in ascending order (showing the newest jobs at the bottom).
Like filters, sort options are stored in the browser URL, and therefore are retained when bookmarking or copying/sharing the URL.