ONC has developed a new tool to help our data users more easily access the citations for searches they complete in Oceans 3.0, while logged in, because we recognize that users are not often thinking about citation at the time of searching or downloading the data. The Search History tool can be accessed through Data Search by clicking on the 'History' button highlighted in red in the image below. Alternatively, this tool can be found at https://data.oceannetworks.ca/SearchHistory
The Search History tool is associated with your Oceans 3.0 user login ID, and so when you complete a search, the parameters of your search will be archived in our database, and accessible to you into the future, making it easier to grab the associated citation for the data you actually used!
SearchHistory archives all details of a data search that results in “Add to Cart” to “Download”.
The Search History interface is simple to navigate, with different ways for users to identify the correct record for their needs. Columns include:
- Path - provides the path taken in the search tree in Data Search to access the data
- Search ID - this is the identifier included in the data download folder in the user’s local directory, and in the file metadata
- Data Product - the data product the user searched
- DateFrom - the earliest date of the data search
- DateTo - the latest date of the data search
- Options - the specific parameters chosen upon data search
- Includes: how to fill data gaps (i.e., NaN, or leave empty), quality (clean or raw), processing type (averaged, min/max, etc.).
- Query Date - the actual date the user searched for the data
- Search Source - where the data was downloaded from, i.e., Data Search, Hydrophone Viewer, etc.
An example of these in real life looks like:
There are additional details associated with the data search when the user selects the down arrow to the left of the Path column.
Additional details include:
- Query PID - this identifier is associated with the minute details of the data search, and is used for providing these details for future users to reproduce the exact same data the original user searched. The is a live link, and resolves to a Dataset Landing Page with to Query Details, in association with the dataset level metadata. More information about Query PIDs can be found in: https://wiki.oceannetworks.ca/display/DP/Data+Citations#DataCitations-QueryPIDLandingPage
- Device - the device name as it’s archived in Oceans 3.0. This is a live link that resolves to the Device Listing page with additional metadata associated with the physical instrument.
- DateFrom - the earliest date of the data search
- DateTo - the latest date of the data search
- SiteID - theSiteID as it’s archived in Oceans 3.0. This is a live link that resolves to the Site page with additional metadata associated with the site, including co-located instruments that may be of interest to users.
- Dataset DOI - this is the generic DOI included in the citation. This is a live link that resolves to the Dataset Landing Page with additional metadata associated with the deployment.
- Copy Citation - a simple and easy way for users to quickly grab the citation, as ONC suggests the dataset be cited. The Query PID (AKA Subset Query) and access dates automatically are appended to the generic citation provided on the Dataset Landing Page, providing future users the ability to easily and clearly identify the correct parameters to reproduce the results derived from the dataset. Orange circle.
Below is an example of these. The red outline shows all searches from one search (i.e., if user selects multiple formats to download, or multiple, specific variables). Green outline shows a specific record for that search, and the orange circle shows where you can easily copy the citation.
This tool is actively being maintained, and functionalities extended, so check back here for updated documentation pertaining to enhancements! If you have any questions, concerns, or suggestions, please contact us as datacitations@oceannetworks.ca.