Canadian Aquatic Biomonitoring Network Database Handbook

Introduction

Access to the CABIN database requires a username and password acquired through CABIN training. Before entering data into a study users must either be a Project Manager or be given access to a CABIN study by a Project Manager. Tasks specific to certain database roles are clearly indicated throughout the handbook.

The primary purpose of this document is to assist in entering, verifying, and exporting data in the CABIN database. This document will also explain how to use additional database features.  Instructions are given for each task to complete when managing data.

If problems are encountered when using the database refer to the troubleshooting section first. Contact the CABIN email for further assistance.

Important Critical information about performing task.

Tip Helpful information to perform tasks efficiently.

Text description

Group of people working together and sharing their files through a cloud system.

Database basics

Logging into the database

CABIN database access requires participation in CABIN Training where a username and password is provided. The CABIN database expects the user to be active while logged in. If a user is inactive after a period of 30 min, the user will receive a “Session timeout warning”.  Data should be submitted frequently to avoid losing unsaved changes.

  1. Go to login page for CABIN database.
  2. Read terms and conditions. Scroll to the bottom of the terms and conditions then click the check box to confirm reading of Data Sharing agreement in order to be able to submit login credentials.
  3. Enter user name and password. 

Important: Database users receive a username and temporary password from an ECCC administrator. We advise changing this after logging in (see Change password). Users are prompted to complete profile information before proceeding when logging in for the first time. Users receive a notification each year to update or confirm profile information.

Database organization

The CABIN web application is organized by core functions that are located at the top of the webpage. This CABIN Database Handbook provides guidance on three Core CABIN Functions: Manage Data, Data Export, and Administration. The remaining two Core CABIN Functions, Data Analysis and Analytical Reports, are explained in the CABIN Analysis and Reporting Handbook. Each function may have a left-hand menu that provides additional options. Tabs appear in the primary activity panel to access specific tasks. Each section of this handbook identifies the breadcrumbs below the Core CABIN Functions that aid in database navigation.

Text description

Screenshot of the CABIN database showing Core CABIN Functions, left-hand menu options and tabs. See description in text below.

Core CABIN functions

Manage Data: This is the default landing page where data are entered and managed in studies (refer to data hierarchy below). This is also where Project Managers can request a new study to be set up in the CABIN database.

Data Analysis: Data that have been entered into the CABIN database can be analysed from this page (Refer to the Analysis and Reporting Handbook).

Analytical Reports: Analyses that have been conducted in a CABIN analysis project can be summarized and presented in individual site reports from this page (Refer to the Analysis and Reporting Handbook).

Data Export: Data from one or more studies and reference models can be exported from this page.

Administration: User profiles and passwords can be modified here. This page also provides additional features for Project Managers to manage user access to their studies. The CABIN taxonomy library is also found here.

CABIN data hierarchy

Text description

Database hierarchy. Refer to the data hierarchy description.

Study: Studies are created within the database to group project related data within the larger CABIN database. A CABIN study is a collection of data that belong to a person, group or organization. Each study has an author (i.e. project authority responsible for data ownership) and must be created by a Project Manager. A study contains a collection of sites usually sampled for a common purpose.

Site: A site is a unique location representing a reach that is 6x bankfull width. It may be sampled one time (i.e. single site visit) or it may sampled multiple times over several years (i.e. many site visits).

Site Visit: A site visit refers to the date that the site was sampled. A site may be revisited every year to track changes over time. New site level information does not need to be entered each year; instead multiple site visits can be entered for a given site.

Sample: A sample refers to a benthic macroinvertebrate collection at a site location during a site visit. In most cases, a single CABIN kick net sample will be taken. In some cases, additional samples will be taken to assess within site variability. The first sample is considered the primary sample where the habitat data are entered. The additional benthic samples are considered QA/QC samples for the purpose of assessing biological variability and are all associated with the habitat data collected for sample 1 (see Data Types below).

Data types

CABIN categorizes all data into two different types: Habitat and Benthic.

Habitat data: Data about the environment including site metadata, location coordinates, field sheet data, water and sediment chemistry data, and GIS-derived landscape data. These describe all environmental attributes about the site where the benthic macroinvertebrate sample was collected.

Benthic data: Benthic macroinvertebrate taxonomic data and associated metadata (i.e. taxonomist and subsample information). 

System profile access & study permissions

CABIN System Profile Access identified in the CABIN User profile relates to the level of training and certification acquired and abilities permissible within the CABIN web application.

 
Training CABIN System Profile Abilities
Project Manager Request CABIN study in database
Grant access permissions to other CABIN users
Enter, edit, view and export data
Analyse data
Data Analyst Enter, edit, view and export data
Analyse data
Field Technician Enter, edit, view and export data
Data Technician Enter, edit, view and export data
Field Assistant No database access

A Project Manager can provide CABIN users access to their study. User permission levels for a given study are defined by the Project Manager. The Project Manager may grant study permissions based on the user’s level of training and certification. The Project Manager may choose to limit access to a subset of tasks regardless of the user’s training. Therefore, user permission levels for a study do not necessarily match the complete set of abilities.

 
User Permissions Level Abilities within a CABIN study
Project Manager Access Grant access permissions to other CABIN users
Enter, edit, view and export data
Analyse data
Data Analyst Access Enter, edit, view and export data
Analyse data
Data Manager Access Enter, edit, view and export data
Data User Access View or export data only

Project manager tools

Requesting a study

  1. Go to Manage Data.
  2. Click Request New Study button on bottom left-hand corner of page.
  3. Enter the study details.
    1. Study Type: select from drop-down
    2. Political Boundary: selected from drop-down
    3. Study Name:
    4. Description: (A few sentences about who is doing the study, why and over what timeframe and geographic region)
    5. Purpose: (A sentence about why the study was created)
    6. Authority: select from drop down (i.e. sector that owns the data)
    7. Date created:
  4. Click Submit. Study requests are automatically sent to the appropriate CABIN Regional Lead for validations. A confirmation email is sent when complete and ready for data entry.

Important: In the spirit of network collaboration and data sharing, CABIN data are publically available by default as per the data sharing terms and conditions on the CABIN login page. There are rare situations where data may be withheld from Open Data for a specified period of time (e.g. legal justification). An appropriate justification is required to set up a study that will remain private for a period of time. For inquiries regarding withholding data, please contact your CABIN regional lead.

Editing study information

  1. Go to Administration and select Study Management from the left-hand menu to access the Search Study page. Enter text to search for a study or select a study from the list.
  2. Go to Edit Study tab.
  3. Update study information as needed and click Submit to save changes.

Important: Refer back to the CABIN terms and conditions on the database login page to review the Data Sharing Agreement.

Adding users to a study

Login > Admin > Search Study > Add New User

  1. Go to Administration.
  2. Select Study Management in the left-hand menu to access the Search Study page.
  3. Enter text to search for a study or select a study from the list.
  4. Go to the Add Users tab, to add user access permissions.
  5. Select the Access Level you wish to grant from the drop-down menu.
  6. Enter the name of the CABIN user in the filter items box.
  7. Check the corresponding check box in the Selected User column.
  8. Click Add Users.
  9. The recently added user and their permission level should now be visible in the User Permissions tab.
Text description

Screenshot of the database “Add Users” functionality. See above for description.

Editing user permission/remove from a study

Login > Admin > Search Study > User Permissions

  1. Go to Administration.
  2. Select Study Management in the left-hand menu to access the Search Study page. Enter text to search for a study or select a study from the list.
  3. Go to User Permissions tab.
  4. Use the drop-down list to select a different permission level OR Remove from Study.
  5. Click Submit. After submitting, the updated user access level should be visible on the refreshed page. Any removed users should no longer be visible.
Text description

Screenshot of the database “User Permissions” functionality. See above for description.

Entering data

Selecting a study

Login > Studies

  1. Go to Manage Data.
  2. Click on the desired Study. If users have access to many studies, the Filter items search field can be used to efficiently search for a particular study.  If a Study has not been set-up in the CABIN database, Project Managers can use the Request New Study button and follow the procedures to create a new study (see Requesting a study).

Tip: Select the Search Study option in the left-hand menu to go to another study at any time.

Text description

Screenshot of the database “Study Search” functionality. See above for description.

Adding a site

Login > Studies > Study Information > Add/Modify Site

  1. From the Study Information page, go to the Add Site tab.
  2. Fill in the Site details fields. The “Alternate Site Code” is an optional field used by some organizations to cross-reference to data or projects stored outside of the CABIN database.
  3. Click Add Site button at the bottom. If the site was successfully added the Database will return to the Study Information tab. The newly created site should now be visible from Site Code drop-down list. 

Tip: Select the Search Study option in the left-hand menu to go to another study at any time.

Adding a site visit

Login > Studies > Study Information > Site Information > Add/Edit Visit

  1. On the Site Information page, click on the Add Visit tab.
  2. Enter the required information below. The CABIN standard requirements are provided in the screen shot of the following page.
    1. Sample Date
    2. Season
    3. Protocol: Select one of the CABIN protocols relevant to the study from the drop-down menu. Other protocols in this drop down list may be legacy protocols or new research and development protocols.
    4. Sampling Device: As organizations transition to CABIN protocols, comparison studies may be conducted. For this reason, other sampling device options can be selected if conducting sampling that does not adhere to CABIN protocols.
    5. # Benthic Replicates: Do not change this number for stream samples. This number applies to mainly to box core samples for CABIN Open water protocols.
    6. Mesh size
    7. Kick time
    8. Sampling Crew
    9. Site Description
  3. Click Add Visit. The Database will return to the Site Information tab where the new site visit data should be visible.
Text description

Screenshot of the database “Add Visit” functionality. See above for description.

Entering location data for site visit

Location coordinates are usually taken at the riffle that is sampled on each site visit (i.e. date of sampling). While the site code for the reach may be the same from year to year, the exact coordinates for the sample location may change slightly among site visits due access issues, water levels, or disturbance at the site. Location information can be entered from the site visit page (see instructions below) or from the Field Sheet data entry page (Refer to Entering field sheet data). In some studies, multiple benthic macroinvertebrate samples may be collected within the reach but only one set of coordinates is entered for the site visit.

Important: Coordinates must be entered as latitude and longitude or degrees/minutes/seconds formats. UTM data must be converted outside of the database.

Login > Studies > Study Information > Site Information > Visit Information > Visit Location

  1. On the Visit Information page, go to the Lat/Long Coordinates tab.
  2. Choose either Degrees/Minutes/Seconds or Decimal Degrees coordinate format. The database will automatically convert to the other format.
  3. Select GPS Datum in the details section and enter elevation information.
  4. Click Submit. The page should refresh and display a map showing the approximate location of the site. 

Tip: Coordinates can also be entered on the Field Sheet section of the Sample Details page. They only need to be entered in one place as the database will automatically update the other.

Text description

Screenshot of the database page “Visit Location” where you can enter location data. See above for description.

Adding a sample

Login > Studies > Study Information > Site Information > Visit Information > Add Sample

  1. On Visit Information page, click on the Add Sample tab.
  2. Select sample status (Test, Potential Reference, or Reference). Sample status can be changed at any time on the on the Sample Details page (click View Sample Data button > Edit Status tab).
  3. Click Submit. The database will return to the Visit Information tab where the new sample should be visible.
  4. Repeat steps 1-3 to add an additional sample (e.g. QA/QC samples). Subsequent samples are automatically assigned test status by default.
Text description

Screenshot of the database page “Visit Information” where you can add a sample. See above for description.

Entering field sheet data

The field sheet contains the required CABIN habitat data collected in the field. Most habitat data collected in the field can be entered from this data entry form.

Tip: The Field Sheet tab is the most efficient method to enter the CABIN Field Sheet data.

Login > Studies > Study Information > Site Information > Visit Information > Sample Details > Field Sheet

  1. On Visit Information page, click on View Sample Data button.
  2. Click on the Field Sheet tab.
  3. Transcribe data from hard copy of field sheet into the matching fields in the database (note that the database does not follow the exact order as seen on CABIN Field Sheet). There are various drop-down lists, check boxes, and value fields to fill in.
  4. Scroll to bottom of Field Sheet page and click Submit to save data. If complete, the database will return to the Summary tab for the sample. If incomplete, the page will refresh and identify any incomplete (missing) at the top of the page. 

Important: Click the submit button at bottom page to any point to ensure data are saved before the database detects inactivity. CABIN will provide notifications of missing info that has yet to be entered.

Entering other habitat data

This section describes how you can enter habitat data that are not on the CABIN field sheet. Water or sediment chemistry and GIS-derived data, not collected in the field, can be entered from the Habitat Tab once data are obtained from the lab or analyst. Note that the Data Upload tool is much more efficient for large datasets.

Login > Studies > Study Information > Site Information > Visit Information > Sample Details > Habitat Data

  1. On the Sample Details page, select the Habitat tab.
  2. Use the Data to enter drop-down to select the category of habitat data.
  3. Click on the Show Variables button. This must be done each time a different habitat category is selected to see the associated variable list.
  4. Click on the Variable (Unit) drop-down to select the variable to enter. Check to make sure the units are correct.
  5. Enter the Value from a field sheet or other data source
  6. Click Add Habitat Data to save the data. The Variable table at the bottom of the page should refresh to display the recently added variable value.

Tip: The Data upload tool is more efficient for larger datasets such as water chemistry and GIS-derived data. The Field Sheet tab is the more efficient way to enter the field recorded habitat measurements like velocity and depth.

Entering channel data (another option)

Channel data includes reach data about widths, depths, velocity, slope, vegetation and aquatic habitats present. The Field Sheet tab is the most effective way to enter the field collected channel data. This tab is another option for entering the same information.

Tip: The Field Sheet tab is the most effective way to enter the field collected channel data.

Login > Studies > Study Information > Site Information > Visit Information > Sample Details > Channel Data

  1. On the Visit Information page, select the Channel Data tab (if all field data were entered in the Field Sheet tab, several channel variables will be already be visible. This is done automatically by the database.)
  2. Enter channel data from field sheet or other data source for non-standard CABIN channel variables.
  3. Click Submit Site Channel Data.

Adding site photos

The CABIN database provides the ability to store site photos. Photos can provide additional information about a site while looking at the data.

Study Information > Site Information > Visit Information > Site Images

  1. On the Visit Information page, click on the Images tab.
  2. Click on the Add Image tab (appears to right of Images tab after clicking on it).
  3. Press the Choose File button and select file to upload. All images must be in jpg/.jpeg format.
  4. Select photo description using the drop-down.
  5. Select the Submit button (this may take a few minutes).
  6. Click the Images tab to see that they are uploaded and labeled correctly. Photos can also be viewed in the slide slow feature that plays in the Summary tab for the sample.

Important: CABIN will compress any individual files greater than 2 MB. The database will display a warning notification if compression occurred.

Text description

Screenshot of the database “Add Image” functionality. See above for description.

Uploading field sheets

The CABIN database provides the ability to store field sheets in a PDF file. It can be very helpful to have access to field sheets while looking at the data.

Login > Studies > Study Information > Site Information > Visit Information

  1. On the Visit Information page, click on the Upload Fieldsheet PDF button.
  2. Choose the .pdf file.
  3. Click Submit. This may take a few seconds.
  4. When complete, the database will go back to the Visit Information tab where buttons to View Fieldsheet and Download should now be visible.

Adding benthic data

CABIN supports the analysis of benthic macroinvertebrate data at the Family level, but recommends that if possible, samples be identified to genus level for reference samples. Some identifications may remain at higher taxonomic level than requested. This may be due to immature or damaged specimens making them difficult to confidently identify. CABIN has a standard taxonomic hierarchy for all levels of benthic macroinvertebrates (Standard Taxonomic Effort). See CABIN Laboratory Methods Manual for more information.

Tip: The Data Upload Tool is a more efficient method to upload community structure data.

Step 1 – Enter taxonomist and sub-sample details

Login > Studies > Study Information > Site Information > Visit Information > Sample Details > Site Community

  1. On the Sample Details page, go to the Community Structure tab (this will go to a new Sub-Sample tab).
  2. Select taxonomist. If the taxonomist is not on the list, they will need to be added by a CABIN Administrator. Contact the CABIN Regional Lead with the taxonomist’s name and information.
  3. Select subsampling method (Marchant Box or By Mass/Weight).
  4. Enter number of Cells or Weight Processed / Total Cells or Sample Weight. The taxonomist will report the proportion of the sample that was subsampled.
    1. Marchant Box: method, enter the number of cells counted in the left-hand box, and the total cells (100) in the right-hand box. If the sample was completely counted (all cells counted in the Marchant box), enter 100 cells/100 total cells.
    2. By Mass or Weight method: enter the proportion that was sub-sampled. For example, if the sample weighed a total of 515.7g and the subsample was 65.2g, the subsample was 12.6% of the total weight (65.2g/515.7g) and would enter 12.6/100.
  5. Click Submit to save Sub-Sample Information. The database will return to the Community Structure tab where taxa and counts can be entered (see Step 2). If needed, go to the Edit Sub-sample option in the left-hand menu to edit taxonomist or sub-sample details.

Step 2 – Search taxa

Login > Studies > Study Information > Site Information > Visit Information > Sample Details > Site Community

  1. On the Sample Details page, go to Community Structure tab.
  2. Search taxa using one of the two following options:
    1. Option 1: Search by Taxa (Text/ITIS):
      1. Enter the name at the lowest taxonomic resolution (i.e. Genus).
      2. Click the hyperlink of the desired taxon. For some names, CABIN may return several options. Review the hierarchy for the options by clicking on each link until the correct one is found. CABIN displays the complete hierarchy for each link in the Search Results section of the Community Structure tab.
      3. The ITIS (Integrated Taxonomic Information System) TSN (Taxonomic Serial Number) can also be used in the search box but is more likely to be used only by taxonomists. Refer to Taxonomy tools: export taxonomy section.
    2. Option 2: Search by classification (Hierarchical):
      1. Select either Phylum, Class, or Order as the starting point and click Go.
      2. Progressively select each taxonomic hierarchy of the taxon by using the drop-down and clicking the Go button. The CABIN database displays the complete hierarchy for each link in the Search Results section of the Community Structure tab.

Tip: Refer to the CABIN Laboratory Methods Manual for accepted nomenclature.

Important: Empty search results could be a taxon not found in the CABIN database or an invalid name. New taxa can be entered with an ITIS (Integrated Taxonomic Information System) TSN (Taxonomic Serial Number) using the “Add New Taxon” button in the left-hand menu (see screenshot). The data will be marked unverified until a voucher is sent to the National Taxonomy lab to be verified and included in the National Reference Collection. Refer to the CABIN Laboratory Methods Manual.

Text description

Screenshot of the database “Community Structure” tab where you can add a taxon. See above for description.

Step 3 – Enter taxa counts

Login > Studies > Study Information > Site Information > Visit Information > Sample Details > Site Community

  1. In the From Bench Sheet section of the Community Structure tab, enter the raw count of taxa from the original data source. The total count will be generated automatically based on the number of sub-samples previously entered.  Include any relevant taxonomist notes.
  2. Click Enter/Edit taxa counts to save data. Pay attention to any warnings about unverified taxa beside the name.  The footnote indicates a voucher specimen needs to be sent to the National Taxonomy Laboratory for verification. Refer to the CABIN Laboratory Methods Manual for more information.
Text description

Screenshot of the database “Community Structure” tab showing a footnote indicating a voucher specimen needs to be sent to the National Taxonomy Laboratory for verification.

Tip: To see the entered counts, click the Community Structure bar at the bottom of the page (see screenshot).

Important: If a correction to an entered taxon name or the number counted is needed (i.e., after a QA/QC audit), the individual entry will need to be deleted and re-entered with the correct name and number. In the event all taxa entries need to be removed for a sample, they can be deleted one-by-one or by deleting the entire sample and all other CABIN data associated with it (field sheet, habitat data, etc.).

Text description

Screenshot of the database “Community Structure” tab and its Community Structure bar at the bottom where you can see the entered counts.

Data upload tool

The data upload tool is particularly useful for data not entered on the standard CABIN Field Sheet. These include taxonomy, water chemistry parameters, and GIS-derived landscape variables. It is more efficient to upload these large datasets into CABIN using the data upload tool. Direct entry is more efficient for creating sites, adding site visits, adding samples, and entering Field Sheet data.

Step 1. Download templates

Login > Studies > Site Information > Upload Data > Download Template

  1. On the Study Information page, select Upload Data on the left-hand menu.
  2. Click on the Download Template tab.
  3. Click on each blue button to download the desired spreadsheet
    1. Template Guide: describes all the variables that can be uploaded to CABIN and formatting specifics for the spreadsheet.
    2. Horizontal Format Data Entry: Flat file where one row represents one site and one parameter.
    3. Vertical Format Data Entry: One row represents one parameter for all sites across the top.
    4. Example with some data.
  4. Click on the FAQ tab to review General Information about the data upload.
Text description

Screenshot of the database page “Download Template”. See above for description.

Step 2. Preparing templates

Templates should be prepared in Excel. The Excel template contains five different worksheets: Sites, Visits, Habitat, Chemistry, and Taxonomy. Use the Template Guide document to input data. Data should be QA/QC’d prior to upload (see CABIN Data QAQC Checklist). Common errors include incorrect cell format, missing or additional spaces in variable fields, and longitude missing the negative sign.

Tip: The CABIN database will truncate data to a maximum of seven (7) decimal places. This is usually only a concern with calculated or GIS derived data. To avoid analytical discrepancies due to decimal places, ensure that the spreadsheet displays values to the maximum number of decimal places.

Important: It is critical that the upload template conforms to units, formats and naming standards found in the Template Guide. The Taxonomy list found in the Administration menu will provide ITIS TSN numbers required for uploading benthic data (see Taxonomy tools: export taxonomy).

Step 3. Upload data

Login > Studies > Site Information

  1. On Study Information page, select Upload Data on the left-hand menu.
  2. Choose file to upload.
  3. Select on either View or Download Only for report options.
    1. View option will return a Finish Upload tab with a link to Download Report (excel file) as well as a summary of the worksheets uploaded and a webpage view of records with upload errors or notes. Always save the download report to check and track errors.
    2. Download only option will return a Finish Upload tab with a link to Download Report (excel file) as well as a summary of the worksheets. This option will not provide a webpage display of the results. Always save the download report to check and track errors.

Important: This is the only opportunity to save the Download Report. The ability to download this document is not available after navigating away from this page.

Tip: Upload history is helpful to see when data were previously uploaded.

Tip: Unused worksheet tabs can be left empty or deleted for upload. This may occur if bulk upload tool is used only for water chemistry, GIS-derived habitat variables, or taxonomy data.

Data verification and validation

Data verification is the process of making sure sample data have been entered completely and accurately from primary sources like field sheets and lab reports. It involves making sure the correct number of sites/samples are present in the database and none have been missed or accidentally duplicated. It also involves checking sample data for missing or incorrectly entered values.

Data validation occurs after data have been verified for completeness and accuracy. It involves making sure sample data are ‘good’ – i.e. reasonable in the context of what is known about the site. Data validation can include comparing sample data to data from nearby sites, or to previous years’ samples at the same site. It can also include checking that values are within a reasonably expected range for that variable.

For Studies with multiple sites, samples, and years of data it may be most efficient to completely verify and validate data in an exported spreadsheet (see Data export), however data verification can also be done within the database environment using Data Entry Status and Sample Details. That process is described below.

View data entry status for a study

Important: The data entry status page will only confirm that data were entered for a site(s), not whether the data entry is complete.

Login > Studies > Study Information > Data Entry Status

  1. Go to Manage Data
  2. Select the study of interest from the Study Search.
  3. Go to the Data Entry Status tab.
  4. Scroll through the page to verify:
    1. that location, habitat, and benthic data have been entered.
    2. if any sites are lacking records compared to others.
  5. If there appears to be any missing data, View the Data Summary (next section) for the sample to confirm/complete data entry as needed.

View data summary for sample

Login > Studies > Study Information > Site Information > Visit Information > Sample Details

  1. From the Study Information page, select a Site from the drop-down menu
  2. Click View Site Information.
  3. Click View Visit Data for the appropriate sampling date.
  4. Click View Sample Data for the sample of interest (primary sample should be Sample Number 1; QA/QC samples, if present, should be Sample 2, Sample 3, etc.).
  5. On the Summary tab of the Sample Details page, scroll down to see all data entered for the sample.
  6. Check against original data sources to verify that all data were entered.
  7. Complete any missing data, if required.
  8. Check data entry accuracy by comparing sample values to original field sheets, GIS or lab reports.

Tip: CABIN recommends checking 10% of the sites entered into a study for data entry errors. If errors are found, they should be corrected and another 10% of the remaining sites should be checked until no errors are found.

Data export

Exporting data into a spreadsheet can make data verification and validation more efficient. Exporting data also allows for additional analyses to be done outside of the CABIN web application. Where Reference Models exist, data from the appropriate reference model may be exported, either on its own or with Study data, to pursue additional analyses outside of the CABIN web application.

Tip: An advantage of exporting Reference Model and Study data together is that variable columns will be seamlessly merged together for analyses.

There are two ways to export data:

  1. Download individual sample reports. This is the simplest option for one or a few sites.
  2. Use the Export Data function. This is a more efficient option to verify and validate or perform calculations on data from multiple sites.

Option 1. Download individual sample report

Login > Studies > Study Information > Site Information > Visit Information > Sample Details

  1. Go to Sample Details page for Sample of interest (See steps 1-4, View data summary for sample).
  2. Select Download sample report from the left-hand menu. This will generate an Excel file containing four different worksheets: Site, Habitat, Chemistry, and Taxonomy. The file will automatically download.

Tip: Download sample report will provide only the final calculated values. Some raw values, like each pebble diameter and individual velocity measurements, are not included in the report.

Option 2. Use the export data function

Login > Data Export

Step 1 – Select data export criteria

  1. Go to Data Export.
  2. Select the Study(ies) from which to export data. One or multiple studies can be selected.
  3. Scroll to the bottom of the page and click Next: Filter Options. The pages that follow provide several selection criteria to narrow the data export.
    1. Include all data or filtered data (by date, site or taxa).
    2. Site status to include in the export (QA/QC, Reference, test, potential reference).
    3. Option to include reference model data with the export (select appropriate model from the drop-down list).
    4. Option to select one or both data types (Benthic and Habitat). Bioassay data is only relevant to the Great Lake CABIN Open Water protocol.
    5. Options to refine the data export for both the Benthic selection (i.e. reduce the export to a specific taxonomic level) and the Habitat selection (i.e. reduce the export to include a specific set of variables).
    6. Option to select how the data will be exported either in a typical site by variable matrix (Horizontal file) or a flat file where each site and variable is a row in the spreadsheet (Vertical file).
Text description

Screenshot of the database “Data Export” functionality. See above for description.

  1. After all export criteria have been selected, the database will show a summary of all export options chosen.
  2. If everything looks correct, click Finish to generate the export data file(s). This may take the CABIN database a few minutes to process depending on the size of file(s).

Tip: Use the Previous button to navigate back through selection criteria to make changes if needed.

Step 2 – Download & view data files

  1. After clicking Finish, the Data Export Results page will appear. Click on the hyperlink(s) to download the file(s).
  2. A summary of exported records is displayed on the page. Benthic and Habitat exports may contain a different number of data records. This could happen due to time lag in Benthic data upload, or when multiple benthic samples were taken. The matching Habitat and Benthic records can be cross-referenced using the Sample ID field.
  3. Notification of any unverified benthic taxa will also appear on the Data Export Results page. All unverified benthic data entries are exported in a separate .csv file or .xls tab.

Tip: Choosing Excel 2010 (.xls) export format will result in a single file containing multiple worksheets. Choosing .csv export format will result in separate files for each data type. When opening the .xls file, an error message and a repair message may appear. Click yes – there are not any actual errors in the file.

Tip: It is recommended to save all exported files for future reference.

Export reference model data only

Any reference model uploaded to the CABIN database can be exported for users to explore the data. Exporting reference model data with user study data was described above (see Option 2. Use the export data function). To export the data for a specific Reference Model without any user study or test site data, follow these direct export steps:

  1. Go to Data Export
  2. Select Reference Models in the left-hand menu.
  3. Select desired export criteria.
  4. Click Finish to generate the Reference Model data file. This may take the CABIN database a few minutes to process.

Tip: Some reference models have updated versions (indicated by year). Older versions remain in the CABIN database for reference. Make sure to choose the correct version of the reference model.

Other database features

Manage data

View public sites

Login > Studies

Public studies as they are referred to in the CABIN web application are studies that are viewable to the participants of the CABIN Network. As a participant in the CABIN network, public studies can also be filtered in Manage Data through the Study Search feature. The Study Search defaults to a list of studies where you have been granted access. Some studies in CABIN have been made available for viewing to the participants in the network. You can see those by changing the filter option from “My Studies” to “Include studies with public sites”.

Text description

Screenshot of the database page “Study Search” where you can see the list of studies you have access to. See above for description.

Study map

Login > Studies > Study Information > Study Map

For each study, a map can be displayed showing all the sites entered into the database and associated metadata. Go to the View Map tab from the Study information page. Click on the Map Instructions drop down arrow for more information on navigating the map. Zoom into your study area. Click on a site of interest to see site and visit appear below the map.

Text description

Screenshot of the database page “View Map”. See above for description.

Study dashboard

Login > Studies > Study Information > Study Dashboard

The study Dashboard provides a quick overview of the metadata within a study. As studies expand over many years with numerous sites, this dashboard provides simple graphics illustrating the sites sampled each year, the number of reference and test sites, and the number of sites within each standard basin (KYW; Know Your Watershed). This page will also provide a list of site codes, site visits, stream names and whether the data are visible to the CABIN network or to the public through Open Data.

Text description

Screenshot of the database feature “Study Dashboard”. See above for description.

Add non-standard habitat data

Login > Studies > Study Information > Site Information > Visit Information > Sample Details > Habitat Data

Other field measured habitat data may be collected in some monitoring programs that are not part of the standard CABIN protocol such as Rapid Bioassessment Habitat Scores and particle size (Physical Variables) or % of the reach comprised of riffles or pools (field measured Hydrology variables). While CABIN does not provide protocols for these variables, data entry for a sample from a given site and site visit is permitted on the Habitat Data tab through Manage Data.

Text description

Screenshot of the database feature “Sample Details – Habitat Data” where you can add non-standard habitat data. See above for description.

Administration

There are different tabs within the Administration function that display information specific to the user while other tabs allow specific actions.

Edit user profile

Login > Admin > User Profile Details > Edit User profile Details

The User Profile Detail tab lists the current profile information for the user. On the Edit User Profile Details tab, most field can be edited. Some information can not be edited by the user. If updates are required, please contact rcba-cabin@ec.gc.ca.

Change password

Login > Admin > User Profile Details > Change Password

During CABIN training, a username and temporary password is provided to the user. It is recommended to change this temporary password on the first login to the database. This action can be done on the Change Password tab.

View user study access list

Login > Admin > User Profile Details > User Study Access List

The User Study Access List tab provides the list of studies for which access has been granted and the level of access granted. Clicking the hyperlink for a given study provides information about the study including the study author. Contact the author if a different level of access is required.

View study and permission information

Login > Admin > Search Study

The Search Study option available through the Study Management option on the left-hand menu is another way to search for study information, including CABIN user study access. Clicking the hyperlink for a given study provides information about the study including the study author and a list of user permission for that study.

Taxonomy tools: search taxa

Login > Admin > Search Taxa

An image library has been created from all aquatic benthic macroinvertebrates held in the CABIN National Reference Collection and searchable within the database. A taxon can be searched in two ways from the Search Taxa option on the left-hand menu in the Administration page. The information page about the taxon displays useful information about taxon hierarchy, images of features and a site occurrence mapping tool.

Option 1: Search by text:
  1. Type in the taxon name or a portion of the name.
  2. Press the Search button.
Option 2: Search by category:
  1. Select a classification level from the drop-down menu.
  2. Pressing the Search button will yield a list of all taxa at the chosen level that are in the CABIN database.
  3. Click the hyperlink for the desired taxon.
Text description

Screenshot of the database “Search Taxa” functionality. See above for description

Taxonomy tools: export taxonomy

A list of all taxa found in the CABIN database can be viewed and exported. This list includes the names and verification status of all taxa found in CABIN samples collected across the country. The list also includes the ITIS (Integrated Taxonomic Information System) TSN (Taxonomic Serial Number) associated with each taxon. This is important for bulk uploading benthic data to the CABIN database. Viewing the entire list is helpful for researchers interested in aquatic benthic macroinvertebrates collected in Canada. The list is found on the Administration page from the Export Taxonomy option on the left-hand menu.

Photo credits: ECCC

Text description

Photos of an insect larvae - above: Isogenoides; below: Agnetina; taken with a laboratory microscope.

Troubleshooting

1. Why is my data not showing up after submitting data?

Try leaving the page and then returning to the page.

2. Why am I getting an Access Denied message?

Ability to use a database feature depends on your certification and assigned permission to a given study. Certain functions in the CABIN database are only accessible by the CABIN Regional Leads (administrators). Go to Study and permission information to see how to confirm your assigned study permissions. If there is an error with your permissions, please contact the Project Manager.

Text description

Screenshot of the database “Access Denied” text box.

3. Why am I getting an error message?

This means the database feature is not working properly. Please notify the generic CABIN email including details of the task you are trying to complete, the function, study, and if relevant – site code and site visit.

Text description

Screenshot of the database “Error 404” text box.

4. Can I edit and delete data after submitting?

There may be cases where you need to edit or even delete a sample or site visit. Please do this carefully. If you do need to delete something, you will receive a message similar to the one below (deleting a site visit, as an example).

Text description

Screenshot of the database “Alert: Confirm Visit Deletion” text box.

Tip: If you are experiencing other database errors contact the CABIN generic email.

Page details

Date modified: