The following policies and steps can also be found in a Word document (“CAS Data Management Procedures”) in the Hydroshare collection, “Climate Adaptation Science Project Work.”
- CAS project participants will make all input data, models, code, results, directions, and other digital artifacts used to generate results available for others to use and share.
- Each CAS participant will chose the Expected Level of Reproducibility (Research artifacts available, Results replicable) for the resource (see Stagge et al (submitted) for descriptions).
- Each CAS participant/group will complete a Data Collection Plan prior to starting project work (see template).
- Hydroshare (http://hydroshare.org) is the primary location to deposit digital artifacts.
- Participants who park digital artifacts in other locations (e.g., Github, Figshare, discipline specific repositories) will create reference links in a Hydroshare resource to point to the artifacts. This resource will provide a container to hold meta data and links to the actual location of the digital artifacts.
- 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.
Steps for Sharing Data, Models, Code, Directions, and other Research Artifacts to Hydroshare
- Create a HydroShare Account at www.hydroshare.org.
- Create a HydroShare resource. At minimum, this requires a title, an abstract, and at least one keyword. Include the keywords “Climate Adaptation Science” and “USUCASProgram”. CAS resources should be composite resource types.
- Add files/content to the resource. For the resource to be shared or discovered, at least one file must be added. HydroShare will handle files of any format, but for CAS, we encourage you to use file types that are portable and non-proprietary (e.g., for table-based data, csv files rather than Excel files). For each resource, multiple files can be loaded, and files may be organized into folders. 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. In the metadata, also note artifacts that cannot be shared (e.g., proprietary data or some human subject data), are available from 3rd parties, or by author request. Metadata may be attached to content files within a resource, and to the resource as a whole. Where the content files added are a HydroShare recognized file type (e.g. geographic shapefile, multidimensional netCDF file, geographic raster file), HydroShare will automatically recognize these files and convert them into content aggregations that hold metadata extracted from the files, and to which metadata can be added.
- Add relevant metadata. In particular, 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. If HydroShare recognized content files are added, spatial and temporal coverage information may be automatically populated.
- Add extended metadata (Name and Value pairs) to describe the expected level of reproducibility a user should expect from the resource and the expected results. Expected levels of reproducibility include Artifacts available, Results reproducible, or Findings replicable. See Stagge et al (submitted) for further descriptions of levels of reproducibility.
Table 1. Extended Metadata Fields to add to the resource
|a. Expected Reproducibility Level||[Artifacts available | Results reproducible | Findings relicable]|
|b. Expected Results||[Description of results generated by the digital artifacts]|
If expected results are described in a paper, report, or other document, add the preprint for the document to the repository and note the location in the Value field.
Steps to create extended metadata in Hydroshare
- Scroll down the resource page to below the button Download All Content as Zipped BagIt Archive. Find the strip of tabs labeled Authorship, Related Resources, Extended Metadata, etc. Click Extended Metadata.
- Click the button +Add New Entry.
- In the Add New Metadata window, enter the first Name as Expected Reproducibility Level and Value
- Repeat steps b and c. Enter the second Name as Expected Results and Value
- Use the Reproducibility Survey Tool (https://goo.gl/LPCTEz) to self-asses the Expected Reproducibility Level of your HydroShare resource stated in Step #5. Use feedback to improve the resource.
Optional Additional Step to Improve Reproducibility
- Ask a Peer/near-Peer to use the Reproducibility Survey Tool (https://goo.gl/LPCTEz) to assess the expected reproducibility level of repository materials.
- Have the assessor leave a New Comment (at the bottom of the resource) that describes the actual level of reproducibility found and suggestions for the author(s) to improve the resource to reach the Expected Reproducibility Level.
Final Steps to Add Resource to the CAS Collection
- Allow the CAS.coordinator to add your resource to the CAS collection.
- Set the resource Sharing Status to Public
- Below Sharing Status, check Shareable.
- At the top of the resource page, click the Manage button, invite the CAS.coordinator, set the access dropdown to Can edit, and click +Add.
- Email the CAS coordinator (firstname.lastname@example.org) the link to your resource and that you feel that your resource is ready to add to the CAS collection. The CAS coordinator will check that the authors are CAS project participants. You may need to make a few edits to the resource to ensure that it meets minimum metadata and completeness standards. The project manager will add Hydroshare resource to the CAS collection.
- 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 that can be cited, makes the content and its metadata description immutable, and should be viewed 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.
- Recognize Peers/Near-Peers for their work to verify the Expected Reproducibility Level of your resource in the acknowledgements of manuscripts and other scientific work that reference your Hydroshare resource.
- HydroShare Help and Support (https://help.hydroshare.org/)
- A novel replicability survey tool to measure and promote reproducibility in hydrology (Stagge et al, submitted).
- Reproducibility Survey Tool (Google Form; Figure 3 at bottom).
- Climate Adaptation Science Project Hydroshare Collection