-
Notifications
You must be signed in to change notification settings - Fork 2
DRAFT: Add documentation for how to use the table filtering section of scicat #13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nickcrawford1
wants to merge
2
commits into
SciCatProject:main
Choose a base branch
from
rosalindfranklininstitute:NEW-table_search_and_filter_doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| ## Finding Datasets | ||
| SciCat provides several possibilities for finding the right datasets. You can use the top search bar, you can narrow down your selection by applying filters and/or conditions and the user can search on scientific metadata as well. | ||
|
|
||
| ### Using Filters and Conditions | ||
| On the left you can apply most common filters. Currently there are | ||
|
|
||
| 1. Location: location of creation of the dataset. | ||
| 2. PID: Identifier of the dataset. | ||
| 3. Groups: who owns the dataset. | ||
| 4. Type: data type - e.g. raw data or derived data. | ||
| 5. Keywords: tags added to the dataset. | ||
| 6. Start - End Date: show datasets captured between the dates that you have set. | ||
| 7. Text: which searches across dataset name and description. | ||
|
|
||
| The text fields provide an auto completion, which becomes visible as you type. | ||
|
|
||
| You can click on the date calendar to select the start date and a second to select end date. Make sure you select 2 dates. | ||
|
|
||
| You can configure the selection of filters and add specific _conditions_. An example shows two additional conditions added: | ||
|  | ||
|
|
||
| ## View Details | ||
| To view a dataset simply click on it in the table and a more detailed view will load (this is covered in the datasets section) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,52 @@ | ||||||
| ## Using column settings | ||||||
| SciCat comes equipped with many useful features and functionalities which enable the user to filter and arrange both their view and exports to suit their needs. This section will describe how to use some of these features along with visual demonstrations to help guide you through the UI. | ||||||
|
|
||||||
| ## Where are the column settings | ||||||
| To access the filters you must use the table menu in the top right corner of the tables header  | ||||||
|
|
||||||
| ## Manipulating the table layout | ||||||
| The initial table for SciCat can contain an abundance of information, but sometimes you might only want to see a specific set of columns information. | ||||||
|
|
||||||
| ### Filtering columns | ||||||
| You can use the column settings option which will enable you to see a list of the available columns and checkbox each one you wish to be part of your view. \ | ||||||
| To select the columns you want to see, simply click the checkboxes ensuring each column of interest is highlighted by the green tick.\ | ||||||
| \ | ||||||
| Once you've selected all of the columns, apply the changes by clicking on the tick in the bottom right corner \ | ||||||
| Now that you've applied the changes to your settings, your table will reflect only the columns you selected. | ||||||
|  | ||||||
|
|
||||||
| ### Reorganising columns | ||||||
| Within the SciCat UI, the columns can be reordered by the user simply by accessing the column setting and using the `drag` option to the left of the column name you wish to move.\ | ||||||
| .png) .png)\ | ||||||
| All columns have this functionality so you can structure the table however suits you best. | ||||||
|
|
||||||
| ### Table filter persistence | ||||||
| When making changes to the table, these changes will not automatically persist so the table will revert to its original form if you: | ||||||
| - refresh the page | ||||||
| - enter into any record and then go back | ||||||
|
|
||||||
| Fortunately, SciCat has a built in way to make the layout persistent and the default. To make the table always filter to your selected columns, first apply the filters as shown above. Go back into the table menu and select the `save table settings` option.\ | ||||||
| \ | ||||||
| This will save the filters to your profile and results in the table formatting you've applied being persistent through refreshes. | ||||||
| **Note: this process will be required each time you wish to change the default column settings** | ||||||
|
|
||||||
| ## Saving data from SciCat | ||||||
| The process of saving or exporting data from Scicat is simple, open the table menu, select `Save data`, choose the output you want.\ | ||||||
| \ | ||||||
| However there are a few important points to understand when saving data from SciCat. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ### What gets saved | ||||||
| SciCat outputs only the data in the current page, meaning; If you have multiple pages of data, only the current page will be output to file. Also the method of output chosen, will result in a different level of data being returned so its important to know what you want to get from this extraction. | ||||||
|
|
||||||
| #### Saving to CSV | ||||||
| \ | ||||||
| This option will return you everything you can see in the table, this includes any filters or ordering that have been applied to the table. So as an output you will get a CSV version of exactly what you have created on the screen. This option is most useful for figure generation or high-level data analysis | ||||||
|
|
||||||
| #### Saving to JSON | ||||||
| \ | ||||||
| The Json option will return you a lot more information as it will save all data related to the records being displayed on that page of the table. This option is very useful for metadata analysis and will provide all fields for each record in the Json format ready to be read/ingested by a program to perform analysis. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| **Note: The returned data from the JSON option will disregard filters so doesn't just collect information from the selected columns, but it will still only return data for the rows displayed on the current page/** | ||||||
|
|
||||||
| ### Saving only specific records | ||||||
| In SciCat there is also the ability to only save data for manually selected data. \ | ||||||
| This option works for both CSV and Json format to only return information about these selected records. However, the other aspects of each saving method still apply so CSV will return a snapshot of what you see, and Json will return all of the data related to just the selected records. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
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.
File renamed without changes
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.
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.