Project Data, Models & Code

CAS is commited to making research more reproducible.

Data Management Procedures

The CAS Program subscribes to the moral and ethical imperative to improve the availability and reproducibility of research artifacts in science (Rosenberg et al., 2020; Stagge et al., 2019). 

In our efforts to push science up the 'reproducilibity continuum', all CAS trainees are required to make all data, models, code, results, directions, and other digitial artifacts relevant to generate results available for others to use and share. CAS trainees utilize HydroShare, a hydrologic information system built for users to share and publish data and models, code and results, directions and other meta-data, to make their CAS projects available in a citable, shareable, and discoverable manner. Below is the CAS HydroShare Collection:

Overarching Policies

CAS trainees and mentors agree to:

  • Make all input data, models, code, results, directions, and other digital artifacts used to generate results available for others to use and share.;
  • Choose the Expected Level of Reproducibility (e.g., Research artifacts available, Results replicable) for the resource (see definitions in Rosenberg et al., 2020).;
  • Complete a Data Collection Plan prior to starting project work (see template; log into Hydroshare to view).;
  • Utilize HydroShare as the primary location to deposit digital artifacts.;
  • Create reference links in a HydroShare resource to point to any digital artifacts parked in other locations (e.g., Github, Figshare, discipline specific repositories). This resource will provide a container to hold metadata and links to the actual location of the digital artifacts.;
    • Where, digital artifacts and data are interpreted broadly to mean all data, models, code, directions, results, and other digital content used to generate results for the work.
  • Share proprietary and human subject data to the extent allowed under access and collection agreements. Where sharing is not possible, provide metadata to describe the contents of data.; and,
  • Set up repositories and provide directions to use materials assuming users are technically proficient in the field but not familiar with the data, models, code, software, programming language, methods, or study materials.

Steps & Timing for Sharing

A resource for CAS trainees and mentors

The following table will guide you through the steps to create a 'resource' in HydroShare that will make your project's digital artifacts available. Timings for each step are specified in the 1st column. Contact any CAS personnel with questions or help with steps; and refer to this document for a full and fleshed out checklist of action items. 

Steps and Timing for Sharing Data, Models, Code, Directions, and other Research Artifacts to HydroShare

2nd Semester, Colloquium

  1. Create a HydroShare Account at www.hydroshare.org.
  2. Create a HydroShare resource. At the top right, click Create => Resource. Include the keywords “Climate Adaptation Science” and "USUCASProgram". CAS resources should be composite resource types.
  3. Complete a Data Collection Plan (see template; log into Hydroshare to view).
  4. Add files/content to the resource. Add your preliminary data, model, or code files. Add anything related to your project. Develop a folder structure that will allow you to add new files and work as your project progresses. Files must include all input data, models, code, model results, detailed metadata, documentation of data collection methods, directions to use materials, and other digital artifacts needed to replicate study results. 
  5. Add relevant metadata. In the metadata: note artifacts that cannot be shared (e.g., proprietary data or some human subject data), are available from 3rd parties, or by author request, add authors and contributors to the dataset, add funding agency credits (National Science Foundation, Climate Adaptation Science, NSF Award Number 1633756), add spatial and temporal coverage information if relevant. 
  6. Create a README File. This file explains the contents and organization of the resource and provides directions to use/run all materials. Assume the user is technically proficient but not familiar with your methods, code, software, etc. Put the README in the root directory!
  7. Allow the CAS.coordinator and EcologyCenterDirector to add your resource to the CAS collection.
 

3rd Semester, Studio I

  1. Meet with a CAS staff. This meeting will help CAS trainees/project groups ensure that they are using their repository and that the repository reflects their current work.
 

4th Semester, Studio II

  1. Meet with a CAS staff. This meeting will help CAS trainees/project groups ensure that they are using their repository and that the repository reflects their current work.
 

Final Steps

Before team submits manuscript for publication

  1. Find a Peer/near-Peer to review your repository and check that all materials are present and/or can reproduce results. If reproducing results, ask the person to use the Checklist in Rosenberg et al., 2021 (Resource, below).

Final Steps to Add Resource to the CAS Collection

  1. Email the CAS coordinator the link to your resource. The CAS coordinator will check that the authors are CAS project participants. The project manager will add the HydroShare resource to the CAS collection.
  2. Formally Publish Your Resource. Click on the “publish resource” icon at the top of the resource landing page (the globe icon). Formally publishing your resource assigns a digital object identifier (DOI) that can be cited, makes the content and its metadata description immutable, and should be viewed as similar to publishing a research paper. This is a FINAL step and should only be done when you are sure that the content files of your resource are complete and that the metadata description has been finalized.
  3. Recognize Peers/Near-Peers for their work in the acknowledgements of manuscript and your HydroShare resource.
  4. Cite your repository in your manuscript in the methods, data availability, result reproducibility, or similar section (follow Journal instructions). In the references, provide full reference information for your repository including authors, title, and the DOI.
  5. Submit your manuscript!!

 

Resources for Trainees & Faculty Mentors

  • Climate Adaptation Science Project Hydroshare Collection (examples)
  • Rosenberg, D. E., Filion, Y., Teasley, R., Sandoval-Solis, S., Hecht, J. S., Zyl, J. E. v., McMahon, G. F., Horsburgh, J. S., Kasprzyk, J. R., and Tarboton, D. G. (2020). "The Next Frontier: Making Research More Reproducible." Journal of Water Resources Planning and Management, 146(6), 01820002. https://doi.org/10.1061/(ASCE)WR.1943-5452.0001215; Preprint.
  • Rosenberg, D. E., Jones, A. S., Filion, Y., Teasley, R., Sandoval-Solis, S., Stagge, J. H., Abdallah, A., Castronova, A., Ostfeld, A., and Watkins, D. (2021). "Reproducible Results Policy." Journal of Water Resources Planning and Management, 147(2), 01620001. https://doi.org/10.1061/(ASCE)WR.1943-5452.0001368.
  • Stagge, J. H., Rosenberg, D. E., Abdallah, A. M., Akbar, H., Attallah, N. A., and James, R. (2019). "Assessing data availability and research reproducibility in hydrology and water resources." Scientific Data, 6, 190030. https://doi.org/10.1038/sdata.2019.30.

Hyrdoshare Help & Support