diff --git a/app/views/hyrax/static/_help_sidebar.html.erb b/app/views/hyrax/static/_help_sidebar.html.erb index 59c249d0..806f3dbb 100644 --- a/app/views/hyrax/static/_help_sidebar.html.erb +++ b/app/views/hyrax/static/_help_sidebar.html.erb @@ -3,7 +3,7 @@

Help

<% end %> <%= render partial: 'help_sidebar' %>

Guide to Creating Documentation for Your Dataset in Deep Blue Data

-

Research Data Services – - researchdataservices@umich.edu  +

Research Data Services – + researchdataservices@umich.edu

Why documentation is important

-

To fully understand, trust, and make use of +

To fully understand, trust, and make use of a dataset created by someone else, researchers often need more than the data files: they need a detailed understanding of the context in which the dataset was created; the methods used to collect, process, and analyze the data; and what the values and -terms in the data signify. Best practices in +terms in the data signify. Best practices in research data curation point to including documentation within a dataset itself as a dependable way to convey comprehensive information about the data, and the research that produced it, to interested members of academic communities and the general -public.

+public.

-

Some of this information +

Some of this information may be provided in journal articles, monographs, or other texts reporting research findings. However, because they are typically written to describe the methods and results, research @@ -39,26 +38,26 @@ headings, variables, and other terms used in the data; and how the individual components of the dataset fit together. Even when this information is provided in a research publication, the text may not be easily accessible to those seeking to -understand and make use of the data. +understand and make use of the data.

What we mean by documentation and metadata

-

Some data curation experts and +

Some data curation experts and practitioners employ the terms documentation and metadata interchangeably. Deep Blue Data chooses to differentiate between the two as, in the context of the repository, they -serve different purposes. +serve different purposes.

-

Metadata here refer to the +

Metadata here refer to the high-level information that researchers provide when depositing data in Deep Blue Data and include the Title, Creator, -Description, Methods, Keywords, and other -descriptive information. Metadata help +Description, Methods, Keywords, and other +descriptive information. Metadata help people who may be interested in a dataset to find it and understand it well enough to decide whether or not they would -like to download it from Deep Blue Data.

+like to download it from Deep Blue Data.

The information included in documentation is more expansive than what is provided in the @@ -105,361 +104,53 @@ documentation:

-

Further reading

+


-

Research Data Services has -created a bibliography of resources to assist researchers in -understanding and creating documentation. The resources -originate from academic institutions, researchers, -repositories, and other organizations. Some resources below -approach the data documentation topic generally, while others -apply to specific kinds of data or research. -

- -

-

- -

General Resources -

- -

-

- -

Cornell University. n.d. “Guide -to writing ‘readme’ style metadata.” Research Data -Management -

- -

Service Group. Accessed Jan. 26, -2018. -https://data.research.cornell.edu/content/readme#bestpractices.

- -

-

- -

Cornell University’s Research -Data Management Service Group has a page sharing detailed -instructions that cover the above recommended topics and more. -The group also has a plain text document template that can -serve as a useful starting point and be modified as -needed. -

- -

-

- -

Dryad. 2018. “Best practices for -creating reusable Dryad data packages.” -

- -

Last revised on Jan. 24, 2018. - -http://datadryad.org/pages/reusabilityBestPractices.

- -

-

- -

Dryad Digital Repository, a -nonprofit research data repository that supports the scientific -and medical disciplines, recommends the creation of README -documents at the file or “data package” levels. This page -outlines content to include in these documents and provides -links to examples in the repository. -

- -

-

- -

Open Science Framework. 2017. -“How to Make a Data Dictionary.” OSF Guides. Updated on -

- -

April 4, 2017. - -http://help.osf.io/m/bestpractices/l/618767-how-to-make-a-data-dictionary.

- -

-

- -

This Open Science Framework -Guide provides column-by-column instructions on creating a data -dictionary — a common way to document the use and meaning of -variables and headers in tabular data files. -

- -

-

- -

Strasser, Carly, Robert Cook, -William Michener, Amber Budden. n.d. “Primer on Data -

- -

Management: What you always -wanted to know.” Data Observation Network for Earth -

- -

(DataONE). Accessed Jan. 29, -2018. -

- -

-https://www.dataone.org/sites/all/documents/DataONE_BP_Primer_020212.pdf. -

- -

-

- -

DataONE — an organization -facilitating discovery of Earth and environmental science -research data and educating researchers on best practices — -gives an introduction to the steps of the data management life -cycle. Sections 5.2 and 5.4 are especially useful for -information about documenting data and the research process. -DataONE also has an extensive list of Best Practices, many of -which relate to documentation, available here - -https://www.dataone.org/all-best-practices. -

- -

-

- -

UK Data Archive. n.d. “Document -your data.” Manage data. Accessed Jan. 26, 2018. -

- -

-https://www.ukdataservice.ac.uk/manage-data/document. -

- -

-

- -

The UK Data Archive, a -repository for social and economics data, provides -recommendations on preparing documentation at the study and -data levels, with specific guidance for quantitative and -qualitative data. -

- -

-

- -

-

- -

Resources Specific to -Disciplines or Data Types -

- -

-

- -

Archaeology Data Service and -Digital Antiquity. n.d. “Project Documentation.” Guides to -Good -

- -

Practice. Accessed Feb. 19, -2017. -

- -

-http://guides.archaeologydataservice.ac.uk/g2gp/CreateData_1-1. -

- -

-

- -

This webpage, part of a resource created by -these archaeological data authorities in the United Kingdom and -United States, include documentation guidance tailored to -archaeological research and datasts. It addresses how to -document stratigraphic units, codes used, and drawings, among -other parts of an archaeological data workflow. -

- -

-

- -

ICPSR (Inter-university Consortium for -Political and Social Research). 2012. Guide to Social

- -

Science Data Preparation and -Archiving: Best Practice Throughout the Data Life -Cycle (5th ed.). Ann Arbor, -Michigan: ICPSR. -

- -

-https://www.icpsr.umich.edu/files/deposit/dataprep.pdf. -

- -

-

- -

A leader in the data curation -field, ICPSR publishes a guide (in PDF format) on preparing -data for deposit that focuses on research data from the social -sciences. Most notably, “Phase 3: Data Collection and File -Creation” (p. 21-32) includes discussion of creating -documentation for quantitative and qualitative data. -

- -

-

- -

Jackson, Mike. n.d. “Writing -readable source code.” Software Sustainability Institute. -Accessed -

- -

Jan. 26, 2018. - -https://software.ac.uk/resources/guides/writing-readable-source-code?_ga=2.180309094.396671004.1516810225-231542810.1516810225#node-131. -

- -

-

- -

For the Software Sustainability -Institute, Mike Jackson writes about best practices for making -source code readable by humans; he covers comments, formatting, -available tools for creating documentation and maintaining code -conventions, and more. -

- -

-

- -

U.S. National Library of -Medicine. 2016. “Common Data Element (CDE) Resource -Portal.” -

- -

Updated March 29, 2016. - -https://www.nlm.nih.gov/cde/.

- -

-

- -

The National Institutes of Health -encourages the use of Common Data Elements (CDEs), which are -common in medical fields to facilitate data quality, data -sharing, and comparison across studies. This portal links to a -suite of resources for determining CDEs for a field or -subfield. -

- -

-

- -

Wilson, Greg, D. A. Aruliah, C. -Titus Brown, Neil P. Chue Hong, Matt Davis, Richard T. -Guy, -

- -

Steven H. D. Haddock, et al. 2014. “Best -Practices for Scientific Computing.” PLOS

- -

Biology 12, no. 1: e1001745. - -https://doi.org/10.1371/journal.pbio.1001745.

- -

-

- -

Taking a broad approach to -improving programming practice in the sciences, this article -includes suggestions on code structure, documentation of the -environment, the use of version control, and writing comments -to enhance research reproducibility. -

- -

-

- -

Have Questions? Need -Help? -

- -

Please contact Research Data Services -- - -researchdataservices@umich.edu 

- -

-

- -

-

+

Have Questions? Need Help?

-

+

Please contact Research Data Services - + researchdataservices@umich.edu

-
-

-

-
+

This document was last updated on May 15, 2018

diff --git a/app/views/hyrax/static/dbd-glossary.html.erb b/app/views/hyrax/static/dbd-glossary.html.erb index 73bbce99..76e6b80a 100755 --- a/app/views/hyrax/static/dbd-glossary.html.erb +++ b/app/views/hyrax/static/dbd-glossary.html.erb @@ -32,7 +32,7 @@

If you come across an unfamiliar term while working with Deep Blue Data, please email us at - deepblue@umich.edu + researchdataservices@umich.edu and we will consider adding it to the glossary.

@@ -49,7 +49,7 @@ he can more conveniently locate and share those datasets with others. If you are interested in creating a Collection, please contact Research Data Services by emailing - deepblue@umich.edu.

+ researchdataservices@umich.edu.

@@ -231,3 +231,12 @@ form.

+


+ +

Have Questions? Need Help?

+ +

Please contact Research Data Services - + researchdataservices@umich.edu +

+ +

This document was last updated on May 15, 2018

\ No newline at end of file diff --git a/app/views/hyrax/static/globus-help.html.erb b/app/views/hyrax/static/globus-help.html.erb index f44cb457..d067e6b5 100644 --- a/app/views/hyrax/static/globus-help.html.erb +++ b/app/views/hyrax/static/globus-help.html.erb @@ -132,4 +132,14 @@ find the icon in the bottom right-hand corner of your screen, (or in the menu/status bar at the top for Mac) right-click (or ctrl-click for Mac) and click "Quit Globus Personal Connect."

+


+ +

Have Questions? Need Help?

+ +

Please contact Research Data Services - + researchdataservices@umich.edu +

+ +

This document was last updated on May 15, 2018

+ <%= render partial: 'help_sidebar' %> diff --git a/app/views/hyrax/static/help.html.erb b/app/views/hyrax/static/help.html.erb index 4ac99e08..d61f843c 100644 --- a/app/views/hyrax/static/help.html.erb +++ b/app/views/hyrax/static/help.html.erb @@ -6,7 +6,7 @@ @@ -284,7 +283,7 @@ multifunctionality @@ -320,7 +319,7 @@ this metadata field is required.

If you would like to split your entry into multiple paragraphs, you may want to make use of the -“+ Add another Description” option.  Multiple entries are +“+ Add another Description” option. Multiple entries are possible for this field. See the note about multiple entries later in this guide.

@@ -347,7 +346,7 @@ Cited in the American Historical Review, 2010-2015 "https://deepblue.lib.umich.edu/data/concern/generic_works/wd375w30z"> Understanding Ecosystem Services Adoption by Natural Resource Managers and Research Ecologists: Survey -Data  +Data

  • More information about Creative -Commons licenses can be found on the -Creative Commons organization’s website and they provide +Creative Commons organization’s website and they provide -an interactive tool to help -you decide which license may be right for you.. -  An entry in this metadata field is +an interactive tool to help +you decide which license may be right for you. An entry in this metadata field is required.

    @@ -479,19 +475,17 @@ this metadata field is optional.

    ORSP Grant Number

    The PAF -number assigned by the University +number assigned by the University of Michigan’s Office of Research and Sponsored Projects (ORSP). -For more information, visit the -ORSP webpage.

    +ORSP webpage    . An entry in this metadata field is optional.

    Keyword

    -

    Enter any terms or topics that describe your work or would help people to find it in Deep Blue Data. Quality keywords may include the following: @@ -582,7 +576,7 @@ libraries

    List the language(s) in which the data and supplementary content are written. These could be spoken languages (e.g. English, Spanish, Mandarin, Arabic, -etc.) or formal languages (e.g. C++, MATLAB, Python, XML, +etc.) or programming languages (e.g. C++, MATLAB, Python, XML, etc.). This information will convey to readers what expertise or technical skills and software they will need to understand the data. Multiple entries are possible for this field. See the @@ -608,7 +602,7 @@ provide a citation for that material.

    Include a full citation where possible. Otherwise, a URL, DOI, or other unique identifier to -the related item will suffice.   +the related item will suffice.

    @@ -725,20 +719,12 @@ Add another [element name],” which will create another field. Repeat this process as needed.

    -

    -

    - -

    This document was last -updated on April 24, 2018. -

    +


    -

    -

    +

    Have Questions? Need Help?

    -

    +

    Please contact Research Data Services - + researchdataservices@umich.edu

    -
    -

    -

    -
    +

    This document was last updated on May 15, 2018

    diff --git a/app/views/hyrax/static/prepare-your-data.html.erb b/app/views/hyrax/static/prepare-your-data.html.erb index 81fbb9eb..534f560e 100644 --- a/app/views/hyrax/static/prepare-your-data.html.erb +++ b/app/views/hyrax/static/prepare-your-data.html.erb @@ -97,3 +97,12 @@ for details. the work was sponsored or supported by an agency or organization other than U-M.
    • +


    + +

    Have Questions? Need Help?

    + +

    Please contact Research Data Services - + researchdataservices@umich.edu +

    + +

    This document was last updated on May 15, 2018

    \ No newline at end of file diff --git a/app/views/hyrax/static/use-downloaded-data.html.erb b/app/views/hyrax/static/use-downloaded-data.html.erb index a56a5b03..1338e1be 100644 --- a/app/views/hyrax/static/use-downloaded-data.html.erb +++ b/app/views/hyrax/static/use-downloaded-data.html.erb @@ -6,14 +6,35 @@ <%= render partial: 'help_sidebar' %>

    Use Downloaded Data

    -

    All data in the Deep Blue Data repository are available to anyone for download without restriction. However, use of data downloaded from the Deep Blue Data repository is subject to our terms of use. Use of the data is also governed by the Creative Common license attached to it. Be sure that you read through the information provided by Creative Commons to understand what you may and may not do with the data.

    +

    All data in the Deep Blue Data repository are available to anyone for download without restriction. + However, use of data downloaded from the Deep Blue Data repository is subject to our terms of use. + Use of the data is also governed by the Creative Common license attached to it. Be sure that you read + through the information provided by Creative Commons + to understand what you may and may not do with the data.

    -

    Content downloaded from Deep Blue Data is provided "as is." Just as with published books or articles available through the library, the library only makes the content available — we have not done any editing. Although we run a virus check on deposit of the data, no check is 100% accurate or foolproof. We therefore cannot guarantee the accuracy, adequacy, quality, or completeness of content from Deep Blue Data, or that downloads are free of viruses or other harmful components.

    +

    Content downloaded from Deep Blue Data is provided "as is." Just as with published books or articles + available through the library, the library only makes the content available — we have not done any editing. + Although we run a virus check on deposit of the data, no check is 100% accurate or foolproof. + We therefore cannot guarantee the accuracy, adequacy, quality, or completeness of content from Deep Blue Data, + or that downloads are free of viruses or other harmful components.

    -

    By using content from Deep Blue Data, you agree that we have no liability for resulting damages and recognize that the statements and views of authors hosted are theirs alone.

    +

    By using content from Deep Blue Data, you agree that we have no liability for resulting damages and recognize + that the statements and views of authors hosted are theirs alone.

    -

    Deep Blue repositories collect usage data. The U-M Library has a policy on privacy and confidentiality on how usage data are collected and used.

    +

    Deep Blue repositories collect usage data. The U-M Library has a + policy on privacy + and confidentiality on how usage data are collected and used.

    Review our policy and terms of use for more details on the use of data sets.

    + +


    + +

    Have Questions? Need Help?

    + +

    Please contact Research Data Services - + researchdataservices@umich.edu +

    + +

    This document was last updated on May 15, 2018