Skip to content

Latest commit

 

History

History

_book

readme.html

<!DOCTYPE html>
<html lang="" xml:lang="">
<head>

  <meta charset="utf-8" />
  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
  <title>1.1 README | Justice Hub: Documentation &amp; Resources</title>
  <meta name="description" content="Documentation and Resources website for the Justice Hub." />
  <meta name="generator" content="bookdown 0.22 and GitBook 2.6.7" />

  <meta property="og:title" content="1.1 README | Justice Hub: Documentation &amp; Resources" />
  <meta property="og:type" content="book" />
  
  
  <meta property="og:description" content="Documentation and Resources website for the Justice Hub." />
  <meta name="github-repo" content="justicehub-in/justice-hub-docs" />

  <meta name="twitter:card" content="summary" />
  <meta name="twitter:title" content="1.1 README | Justice Hub: Documentation &amp; Resources" />
  
  <meta name="twitter:description" content="Documentation and Resources website for the Justice Hub." />
  

<meta name="author" content="Team Justice Hub" />


<meta name="date" content="2021-08-19" />

  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <meta name="apple-mobile-web-app-capable" content="yes" />
  <meta name="apple-mobile-web-app-status-bar-style" content="black" />
  
  
<link rel="prev" href="dataset.html"/>
<link rel="next" href="data-dictionary.html"/>
<script src="libs/header-attrs-2.9/header-attrs.js"></script>
<script src="libs/jquery-2.2.3/jquery.min.js"></script>
<link href="libs/gitbook-2.6.7/css/style.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-table.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-bookdown.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-highlight.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-search.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-fontsettings.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-clipboard.css" rel="stylesheet" />









<link href="libs/anchor-sections-1.0.1/anchor-sections.css" rel="stylesheet" />
<script src="libs/anchor-sections-1.0.1/anchor-sections.js"></script>




<link rel="stylesheet" href="css/style.css" type="text/css" />
</head>

<body>



  <div class="book without-animation with-summary font-size-2 font-family-1" data-basepath=".">

    <div class="book-summary">
      <nav role="navigation">

<ul class="summary">
<li><a href="./">Justice Hub - Resources</a></li>

<li class="divider"></li>
<li class="chapter" data-level="" data-path="index.html"><a href="index.html"><i class="fa fa-check"></i>Preface</a></li>
<li class="chapter" data-level="1" data-path="dataset.html"><a href="dataset.html"><i class="fa fa-check"></i><b>1</b> The Dataset</a>
<ul>
<li class="chapter" data-level="1.1" data-path="readme.html"><a href="readme.html"><i class="fa fa-check"></i><b>1.1</b> README</a></li>
<li class="chapter" data-level="1.2" data-path="data-dictionary.html"><a href="data-dictionary.html"><i class="fa fa-check"></i><b>1.2</b> Data Dictionary</a></li>
<li class="chapter" data-level="1.3" data-path="license.html"><a href="license.html"><i class="fa fa-check"></i><b>1.3</b> License</a></li>
<li class="chapter" data-level="1.4" data-path="dataset-reproducibility-links.html"><a href="dataset-reproducibility-links.html"><i class="fa fa-check"></i><b>1.4</b> Dataset Reproducibility</a></li>
<li class="chapter" data-level="1.5" data-path="data-repositories.html"><a href="data-repositories.html"><i class="fa fa-check"></i><b>1.5</b> Data repositories</a></li>
</ul></li>
<li class="chapter" data-level="2" data-path="data-accessibility.html"><a href="data-accessibility.html"><i class="fa fa-check"></i><b>2</b> Making open datasets more accessible</a></li>
<li class="chapter" data-level="3" data-path="legal-data-platforms.html"><a href="legal-data-platforms.html"><i class="fa fa-check"></i><b>3</b> Legal Data Platforms</a></li>
<li class="chapter" data-level="4" data-path="policies.html"><a href="policies.html"><i class="fa fa-check"></i><b>4</b> Policies</a></li>
<li class="chapter" data-level="5" data-path="howtos.html"><a href="howtos.html"><i class="fa fa-check"></i><b>5</b> How-To’s</a>
<ul>
<li class="chapter" data-level="5.1" data-path="dataset-upload.html"><a href="dataset-upload.html"><i class="fa fa-check"></i><b>5.1</b> Uploading a dataset</a></li>
<li class="chapter" data-level="5.2" data-path="dataset-search.html"><a href="dataset-search.html"><i class="fa fa-check"></i><b>5.2</b> Searching for datasets on the hub</a>
<ul>
<li class="chapter" data-level="5.2.1" data-path="dataset-search.html"><a href="dataset-search.html#simple-search"><i class="fa fa-check"></i><b>5.2.1</b> Simple Search</a></li>
<li class="chapter" data-level="5.2.2" data-path="dataset-search.html"><a href="dataset-search.html#advanced-search"><i class="fa fa-check"></i><b>5.2.2</b> Advanced Search</a></li>
</ul></li>
</ul></li>
<li class="chapter" data-level="6" data-path="platform-links.html"><a href="platform-links.html"><i class="fa fa-check"></i><b>6</b> Links</a></li>
</ul>

      </nav>
    </div>

    <div class="book-body">
      <div class="body-inner">
        <div class="book-header" role="navigation">
          <h1>
            <i class="fa fa-circle-o-notch fa-spin"></i><a href="./">Justice Hub: Documentation &amp; Resources</a>
          </h1>
        </div>

        <div class="page-wrapper" tabindex="-1" role="main">
          <div class="page-inner">

            <section class="normal" id="section-">
<div id="readme" class="section level2" number="1.1">
<h2><span class="header-section-number">1.1</span> README</h2>
<p>A README is often the first place people will go to learn more about anything in a folder - they are very common in software, and historically were included so the uppercase letters of README meant it would be at the top of a directory. The README is meant for someone to read and understand more about the data and contains the <code>who, what, when, where, why, &amp; how</code>:</p>
<ul>
<li><strong>Who</strong> collected it</li>
<li><strong>What</strong> is the data</li>
<li><strong>When</strong> was it collected</li>
<li><strong>Where</strong> was it collected</li>
<li><strong>Why</strong> it was collected</li>
<li><strong>How</strong> is was collected</li>
</ul>
<p>With one README per dataset, It should be brief, and provide links to the other aforementioned sections. It should also contain any other guidance for the user on how to read and interpret the whole dataset.</p>
<p><strong>References</strong></p>
<ul>
<li><a href="https://github.com/vera-institute/incarceration_trends/blob/master/README.md">Vera Institute of Justice - Incarceration Trends Dataset</a></li>
</ul>
</div>
            </section>

          </div>
        </div>
      </div>
<a href="dataset.html" class="navigation navigation-prev " aria-label="Previous page"><i class="fa fa-angle-left"></i></a>
<a href="data-dictionary.html" class="navigation navigation-next " aria-label="Next page"><i class="fa fa-angle-right"></i></a>
    </div>
  </div>
<script src="libs/gitbook-2.6.7/js/app.min.js"></script>
<script src="libs/gitbook-2.6.7/js/lunr.js"></script>
<script src="libs/gitbook-2.6.7/js/clipboard.min.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-search.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-sharing.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-fontsettings.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-bookdown.js"></script>
<script src="libs/gitbook-2.6.7/js/jquery.highlight.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-clipboard.js"></script>
<script>
gitbook.require(["gitbook"], function(gitbook) {
gitbook.start({
"sharing": null,
"fontsettings": {
"theme": "white",
"family": "sans",
"size": 2
},
"edit": {
"link": "https://github.com/justicehub-in/justice-hub-docs/edit/master/01-dataset.Rmd",
"text": "Edit"
},
"history": {
"link": null,
"text": null
},
"view": {
"link": null,
"text": null
},
"download": null,
"toc": {
"collapse": "none",
"scroll_highlight": true
}
});
});
</script>

</body>

</html>