Adding References

The References sections allow you to link to sources of data and/or to content related to the data. HydroShare will allow you to modify published resources to add references to related content (e.g., journal papers that use the data contained in a resource).

Sources

If the data in your resource was derived from another source or dataset, you can cite or acknowledge it in the References section under Sources. Click on the plus sign next to "Sources" and then add a full text citation to the original content, a web link, or text describing the source of the data.

Related Resources

HydroShare also allows you to link your HydroShare data with related content, or resources. For example, you may want to record a relationship between the dataset you have created in HydroShare and a journal paper that uses or cites that dataset. Each relationship is a text field that may hold a link (expressed as a URL) or full reference information for related content. Where possible, the relationship field should not be limited to only a URL, but should hold the full bibliographic information for the referenced content. HydroShare also allows you to specify the type of relationship you want to store. The following relationship types are supported:

The content of this resource was copied from: If your HydroShare resource is a copy of another HydroShare resource or of content that is hosted or exists somewhere else, you can use this relationship type to refer to the location from which the content in your HydroShare resource was copied.

The content of this resource is part of: Use this relationship type to refer to another resource that your  resource is part of. “Part of” relationships are automatically created when a resource is added to a HydroShare collection resource.

The content of this resource can be executed by: Use this to refer to a resource that may execute the current resource, such as the model program associated with a model instance. This relationship type enables you to maintain the relationship between a model instance resource and the specific model or models that can be used to execute it.

The content of this resource was created by: Use this relationship type to refer to a resource that created the current resource. Examples include a model program resource or a web app that created the current resource. This relationship type is meant to help store provenance about the tools or software used to create the resource. To describe who created the resource, use the Author or Contributor metadata instead.

The content of this resource serves as the data for: Use this relationship type to refer to a resource that your HydroShare resource has been used in. Examples include another HydroShare resource that uses data from your resource, a journal paper that uses the data, or a graduate thesis or dissertation. This relationship type is meant to help you store information about other resources that were created using the content from your HydroShare resource.

This resource cites: Use this relationship type to refer to a resource that your HydroShare resource cites. This is a way for you to create a list of references for your resource. You can cite papers, websites, etc.

This resource is described by: Use this relationship type to refer to a resource that describes your HydroShare resource. For example, you might want to store a relationship with a paper, news item on the Internet, or other media type that describes the content of a particular resource.

Examples

Linking your resource with a publication

Relationships provide a way to associate a HydroShare resource with a publication.  Data published in HydroShare and used in a paper should be cited in the paper’s reference list using the full HydroShare citation, including DOI, for the published resource (see “How to Cite” on the resource’s landing page in HydroShare).  For example:

Tarboton, D. (2017). Logan Specific Catchment Area, HydroShare, http://dx.doi.org/10.4211/hs.877bf9ed9e66468cadddb229838a9ced

The HydroShare resource should then refer back to the paper using an appropriate relationship type (e.g., “The content of this resource is data for” or “This resource is described by”). For example:

The relationship type to use depends on whether the paper serves to describe the data (use “This resource is described by”), or just use the data held in the resource (use “The content of this resource serves as the data for”).

If the Journal Publication is Not Yet Accepted

It is important to realize that you cannot edit the authorship, title, or content files of a HydroShare resource once it is formally published and receives a DOI. However, you can add relationship metadata to published resources if needed (e.g., adding a reference to a related paper if the paper is published after the resource is published).  If you are certain that the data/content in your resource is complete, finished, and will not change, you can formally publish your resource prior to submitting your related paper for publication and cite it using the resource’s DOI in the References section of your paper. Once the related paper is published, you can then edit the resource and add a reference to the paper to the published resource’s metadata.

However, if you anticipate that the content of your resource might change based on feedback from the reviewers of your paper, you may choose to leave the HydroShare resource public but unpublished during your paper’s review process. In the paper, you would cite the resource as follows:

Author’s last name(s), year. Title of Hydroshare Resource, HydroShare. Unpublished Resource URL.

 

For example, this resource: https://www.hydroshare.org/resource/877bf9ed9e66468cadddb229838a9ced/ would have the following citation in the journal paper submitted for review:

Tarboton, D., 2015. Logan Specific Catchment Area, HydroShare. http://www.hydroshare.org/resource/877bf9ed9e66468cadddb229838a9ced.

 

When the paper is accepted for publication and you are confident that your HydroShare resource and its metadata will no longer change, you should formally publish the resource to receive a DOI and then change the citation to the HydroShare resource in the References list in the paper during the copyediting/publication process to:

Tarboton, D. (2017). Logan Specific Catchment Area, HydroShare, http://dx.doi.org/10.4211/hs.877bf9ed9e66468cadddb229838a9ced.

 

Note that HydroShare uses the following pattern when creating DOIs:

“10.4211/hs.<HydroShare_internal_identifier>”

The DOI uses “10.4211/hs.” followed by HydroShare’s internal identifier for your resource, which is created when you first create your resource in HydroShare. You can anticipate this pattern for the DOI of your published HydroShare Resource, even before it is formally published in HydroShare. However the URL of the resource containing the DOI (e.g., http://dx.doi.org/10.4211/hs.877bf9ed9e66468cadddb229838a9ced) will not work until your resource has been formally published. 

When finalizing a paper for publication, you should first ensure that your resource is published and has been issued a DOI. You should then change the reference to your HydroShare resource in the paper to use the URL that contains the DOI.  As soon as the published paper has been assigned a DOI, you should then edit the HydroShare resource to add a relationship with the full bibliographic citation that points to the paper.  

Note that upon submission of a resource for formal publication in HydroShare, it will be checked for completeness by CUAHSI during the DOI registration process.

 

If the resource components are copied from an external source

Sometimes a user would like to archive a specific version of a resource that is published by an external source so he or she can link it with other resources in the HydroShare system. This is a common use case, especially for a model program as users may want to archive a frozen copy of a specific model version that is officially published by the model provider, in the HydroShare system. This way it can be used with model instances in HydroShare to guarantee the reproducibility of the same model instance resource output. For example, the EPA-SWMM model version 5.1.010 is used to execute a specific model instance use case that is archived through HydroShare. Therefore, there is a need to preserve a copy of this specific model version in HydroShare to guarantee the reproducibility of the same model instance output. A copy of this model was archived in the HydroShare system and the “isCopiedFrom” relation is used to record and give credit to the model website as a primary source. By using this relationship, the following citation was generated automatically by the HydroShare system:

Rossman, L., T. Schade, D. Sullivan, R. Dickinson, C. Chan, E. Burgess (2017). Storm Water Management Model (SWMM), http://www2.epa.gov/water-research/storm-water-management-model-swmm, accessed 6/30/2017, replicated in HydroShare at: http://www.hydroshare.org/resource/2cddae40e9594c21b947fdbbe4225439


Relationships with Model resources

Important note: The Model Instance and Model Program resources are no more supported in HydroShare; instead they are superseded by Model Instance and Model Program aggregations. The content of this section will undergo some necessary edits soon to reflect the aforementioned change but the resources mentioned below are still accessible. 

There are several relationships that can be used with the model resource types in HydroShare. For example, a model instance resource can be related to the specific resource that executes it using the “ExecutedBy” relation. This model instance resource that includes the post-processed input data can be also be related to the resource containing the raw data in the HydroShare system using the “DerivedFrom” relation. This model instance can be combined with other resources in a collection resources type. The “IsPartOf” relation can be used to indicate the collection resource that the model instance resource is a part of. For example, the “ModflowNwtSciunitOutput” MODFLOW model instance resource is derived from (“DerivedFrom” relation) a generic model instance resource, “ModflowNwtRawData”, that includes the raw data. It is executed by (“IsExecutedBy” relation) a composite resource, “ModflowNwtSciunit”, and is a part of (“IsPartOf” relation) a collection resource, “ModflowNwtCollection.” When a resource is made a part of a collection resource, that relationship is indicated on the resource’s landing page with the text: “This resource belongs to the following collections:” (see screenshot below).