Skip to content

Commit caf49e2

Browse files
author
GitHub Actions
committed
Deploy PrincetonUniversity/c19datacollective to PrincetonUniversity/c19datacollective:gh-pages
0 parents  commit caf49e2

30 files changed

+4053
-0
lines changed

‎.nojekyll

Whitespace-only changes.

‎404.html

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
2+
3+
<!doctype html>
4+
<html lang="en">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1" />
8+
<link rel="stylesheet" href="/style.css" /><title>404 Not Found | Nineteenth-Century Data Collective</title>
9+
<meta name="author" content="C19 Data Collective" />
10+
<meta name="description" content="The Nineteenth-Century Data Collective peer-reviews and houses literary or cultural data, circa 1800-1900, on an open-access website." />
11+
12+
<script async src="/elasticlunr.min.js"></script>
13+
<script async src="/search_index.en.js"></script>
14+
</head>
15+
16+
<body>
17+
<header id="menu">
18+
<div class="menu-inner">
19+
<a id="menu-title" href="/">C19 Data Collective</a>
20+
<input id="menu-toggle-button" type="checkbox" />
21+
<label id="menu-toggle-label" for="menu-toggle-button">Menu</label>
22+
<ul id="menu-items">
23+
<li><a href="/submit">Submission</a></li>
24+
<li><a href="/criteria">Criteria</a></li>
25+
<li><a href="/resources">Resources</a></li>
26+
<li><a href="/data">Our Data</a></li>
27+
<li><a href="/people">People</a></li>
28+
<li><button popovertarget="search-dialog">Search</button></li>
29+
</ul>
30+
</div>
31+
</header>
32+
33+
<dialog popover id="search-dialog">
34+
<div id="search-dialog-inner">
35+
<input
36+
id="search-bar"
37+
type="search"
38+
placeholder="What are you looking for?"
39+
/>
40+
<div id="search-results"><p>No results found.</p></div>
41+
<button popovertarget="search-dialog">Close</button>
42+
</div>
43+
</dialog>
44+
45+
46+
47+
48+
<main class="">
49+
50+
<h1>Page not Found</h1>
51+
<p>
52+
Something went wrong?
53+
<a href="https://github.com/PrincetonUniversity/c19datacollective/issues/new">Submit an issue</a>
54+
or <a href="mailto:ask@c19datacollective.com">contact us</a>.
55+
</p>
56+
57+
</main>
58+
59+
<footer>
60+
<div class="footer-inner">
61+
<a href="mailto:ask@c19datacollective.com">Email Us</a>
62+
<span>C19 Data Collective &copy; 2023</span>
63+
</div>
64+
</footer>
65+
66+
<script defer src="/js/script.js"></script>
67+
<script defer src="/js/search.js"></script></body>
68+
</html>

‎C19dataset_READMEtemplate.txt

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
This [DATASETNAME]readme.txt file was generated on YYYY-MM-DD by [RESEARCHER NAME]for the C19 Data Collective.
2+
3+
4+
5+
GENERAL INFORMATION
6+
7+
1. Title of Dataset:
8+
9+
2. Author Information
10+
A. Principal Investigator Contact Information
11+
Name:
12+
Institution:
13+
Address:
14+
Email:
15+
16+
B. Associate or Co-investigator Contact Information
17+
Name:
18+
Institution:
19+
Address:
20+
Email:
21+
22+
C. Alternate Contact Information
23+
Name:
24+
Institution:
25+
Address:
26+
Email:
27+
28+
3. Date of data collection (single date, range, approximate date) <suggested format YYYY-MM-DD>:
29+
30+
4. Geographic location of data collection <latitude, longitude, or city/region, State, Country, as appropriate>:
31+
32+
5. Funding sources and associated grant numbers that supported the collection of the data:
33+
34+
35+
SHARING/ACCESS INFORMATION
36+
37+
1. Licenses/restrictions placed on the data:
38+
Licenses/restrictions placed on the code:
39+
40+
2. Links to publications that cite or use the data:
41+
42+
3. Links to other publicly accessible locations of the data:
43+
44+
4. Links/relationships to ancillary data sets:
45+
46+
5. Was data derived from another source? yes/no
47+
A. If yes, list source(s):
48+
49+
50+
51+
DATA & FILE OVERVIEW
52+
53+
1. File List:
54+
<list all files (or folders, as appropriate for dataset organization) contained in the dataset, with a brief description>
55+
56+
2. Relationship between files, if important:
57+
58+
3. Additional related data collected that was not included in the current data package:
59+
60+
4. Are there multiple versions of the dataset? yes/no
61+
A. If yes, name of file(s) that was updated:
62+
i. Why was the file updated?
63+
ii. When was the file updated?
64+
65+
66+
METHODOLOGICAL INFORMATION
67+
68+
1. Description of methods used for collection/generation of data:
69+
<Include links or references to publications or other documentation containing any protocols used in data collection>
70+
71+
2. Methods for processing the data:
72+
<describe how the submitted data were generated from the raw or collected data>
73+
74+
3. Software-specific information needed to open or interpret the data:
75+
<include full name and version of software, and any necessary packages or libraries needed to run scripts>
76+
77+
4. Describe any quality-assurance procedures performed on the data:
78+
<include any resources used in normalizing data, such as Thesauri, Gazetteer's, etc>
79+
80+
5. People involved with sample collection, processing, analysis and/or submission:
81+
82+
83+
DATA-SPECIFIC INFORMATION FOR: [FILENAME]
84+
<repeat this section for each dataset, folder or file, as appropriate>
85+
86+
1. Number of variables:
87+
88+
2. Number of cases/rows:
89+
90+
3. Variable List:
91+
<list variable name(s), description(s), unit(s)and value labels as appropriate for each>
92+
93+
4. Missing data codes:
94+
<list code/symbol and definition>
95+
96+
5. Specialized formats or other abbreviations used:
97+
98+

‎cover.jpg

771 KB
Loading

‎criteria/data-documentation/index.html

+209
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,209 @@
1+
2+
3+
<!doctype html>
4+
<html lang="en">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1" />
8+
<link rel="stylesheet" href="/style.css" /><title>Data Documentation | Nineteenth-Century Data Collective</title>
9+
<meta name="author" content="C19 Data Collective" />
10+
<meta name="description" content="The Nineteenth-Century Data Collective peer-reviews and houses literary or cultural data, circa 1800-1900, on an open-access website." />
11+
12+
<script async src="/elasticlunr.min.js"></script>
13+
<script async src="/search_index.en.js"></script>
14+
</head>
15+
16+
<body>
17+
<header id="menu">
18+
<div class="menu-inner">
19+
<a id="menu-title" href="/">C19 Data Collective</a>
20+
<input id="menu-toggle-button" type="checkbox" />
21+
<label id="menu-toggle-label" for="menu-toggle-button">Menu</label>
22+
<ul id="menu-items">
23+
<li><a href="/submit">Submission</a></li>
24+
<li><a href="/criteria">Criteria</a></li>
25+
<li><a href="/resources">Resources</a></li>
26+
<li><a href="/data">Our Data</a></li>
27+
<li><a href="/people">People</a></li>
28+
<li><button popovertarget="search-dialog">Search</button></li>
29+
</ul>
30+
</div>
31+
</header>
32+
33+
<dialog popover id="search-dialog">
34+
<div id="search-dialog-inner">
35+
<input
36+
id="search-bar"
37+
type="search"
38+
placeholder="What are you looking for?"
39+
/>
40+
<div id="search-results"><p>No results found.</p></div>
41+
<button popovertarget="search-dialog">Close</button>
42+
</div>
43+
</dialog>
44+
45+
46+
47+
48+
<main class="
49+
50+
51+
has-toc
52+
53+
">
54+
55+
56+
<h1>Data Documentation</h1>
57+
58+
59+
60+
61+
62+
63+
64+
65+
66+
<nav class="toc toc-show">
67+
<h2>Table of Contents</h2>
68+
<ul>
69+
70+
<li>
71+
<a href="#key-ethical-considerations">Key Ethical Considerations</a>
72+
73+
</li>
74+
75+
<li>
76+
<a href="#essential-tasks">Essential Tasks</a>
77+
78+
<ul>
79+
80+
<li>
81+
<a href="#a-readme-file">A README file</a>
82+
</li>
83+
84+
<li>
85+
<a href="#file-and-folder-names">File and Folder Names</a>
86+
</li>
87+
88+
</ul>
89+
90+
</li>
91+
92+
</ul>
93+
94+
95+
<h3><a href="/criteria/">Also in Criteria</a></h3>
96+
<ul>
97+
98+
99+
<li><a href="/criteria/dataset-preparation/">Dataset Preparation</a></li>
100+
101+
102+
103+
104+
105+
<li><a href="/criteria/data-essay/">Data Essay Criteria</a></li>
106+
107+
108+
109+
<li><a href="/criteria/metadata/">Metadata</a></li>
110+
111+
112+
</ul>
113+
114+
115+
<a href="#" class="back-to-top" onclick="document.documentElement.scrollTop = 0;"> Back to Top</a>
116+
</nav>
117+
118+
<script defer src="/js/toc.js"></script>
119+
120+
121+
<article>
122+
<p>Examine the dataset closely to understand what it is, how the files interrelate, and what information is needed to reuse.</p>
123+
<ul>
124+
<li>Check for quality assurance and usability issues such as missing data, ambiguous headings, code execution failures, and data presentation concerns</li>
125+
<li>Try to detect and extract any “hidden documentation” inherent to the data files that may facilitate reuse or expose unintended information</li>
126+
<li>Determine if the documentation of the data is sufficient for a user with similar qualifications to the researcher’s to understand and reuse the data. If not, create additional documentation (e.g., a data dictionary)</li>
127+
</ul>
128+
<h2 id="key-ethical-considerations">Key Ethical Considerations</h2>
129+
<ul>
130+
<li>If working with human data, is this research done with and not on communities and populations involved?
131+
<ul>
132+
<li>Are there authoritative group representatives who should be contacted?</li>
133+
</ul>
134+
</li>
135+
<li>Are there labels or other descriptive indicators that could be applied to better represent or protect an identified group of people impacted by this dataset? (Example: <a href="https://localcontexts.org/labels/traditional-knowledge-labels/">TK labels</a>)</li>
136+
</ul>
137+
<h2 id="essential-tasks">Essential Tasks</h2>
138+
<h3 id="a-readme-file">A README file</h3>
139+
<p><a href="/C19dataset_READMEtemplate.txt">See here for a README template.</a></p>
140+
<p>Acceptable formats include <code>txt</code>, <code>rtf</code>, or <code>mdl</code>. For more information about READMEs, see <a href="https://data.research.cornell.edu/content/readme">Cornell University’s Guide to writing “readme” style metadata</a>.</p>
141+
<ul>
142+
<li>Include complete documentation about your dataset
143+
<ul>
144+
<li>Provenance Information</li>
145+
<li>Licensing Information</li>
146+
<li>Descriptions of Study Level and/or Data Level information:
147+
<ul>
148+
<li>Study-level data documentation:
149+
<ul>
150+
<li>Provenance of information gathered in this dataset</li>
151+
<li>Methods used to acquire, organize, or normalize this data</li>
152+
<li>Descriptions of any transformations that this data has undergone</li>
153+
</ul>
154+
</li>
155+
<li>Data-level documentation:
156+
<ul>
157+
<li>Contents of data files</li>
158+
<li>Definitions of all variables, labels, descriptions, units of measurement used in data files</li>
159+
<li>Defined labels or codes used to indicate missing data (ie no blank spaces, but what would indicate unknown or missing)</li>
160+
</ul>
161+
</li>
162+
</ul>
163+
</li>
164+
</ul>
165+
</li>
166+
<li>Include participant information and codebooks (if applicable)</li>
167+
<li>Check the accessibility of all files
168+
<ul>
169+
<li>Each file can be opened without proprietary software</li>
170+
<li>There are robust descriptions in plain text of data files and any images.</li>
171+
</ul>
172+
</li>
173+
</ul>
174+
<h3 id="file-and-folder-names">File and Folder Names</h3>
175+
<p>How are your files (and folders) named?</p>
176+
<ul>
177+
<li>Are names consistent?</li>
178+
<li>Are the names meaningful?</li>
179+
<li>Have you documented each of the file (and folder) names?</li>
180+
<li>Do the file and folder names reflect versioning? (i.e. updated files are named in a way that is findable without opening up the files themselves)</li>
181+
</ul>
182+
<h4 id="don-ts">Don’ts:</h4>
183+
<ul>
184+
<li>Use special characters in the file name</li>
185+
<li>Leave blank spaces in the file name</li>
186+
<li>Use different naming logics for each file or type of file</li>
187+
</ul>
188+
<h4 id="do-s">Do’s:</h4>
189+
<ul>
190+
<li>Use less than 25 characters per file name</li>
191+
<li>Use ISO 8601 to format dates: YYYY-MM-DD</li>
192+
<li>Use capitals or underscores instead of spaces or periods</li>
193+
<li>Write down your naming convention</li>
194+
</ul>
195+
196+
</article>
197+
198+
</main>
199+
200+
<footer>
201+
<div class="footer-inner">
202+
<a href="mailto:ask@c19datacollective.com">Email Us</a>
203+
<span>C19 Data Collective &copy; 2023</span>
204+
</div>
205+
</footer>
206+
207+
<script defer src="/js/script.js"></script>
208+
<script defer src="/js/search.js"></script></body>
209+
</html>

0 commit comments

Comments
 (0)