-
Notifications
You must be signed in to change notification settings - Fork 0
/
AUTHOR_ReadmeTemplate.txt
178 lines (83 loc) · 3.63 KB
/
AUTHOR_ReadmeTemplate.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
This AUTHORLAST_readmeYYYYMMDD.txt file was generated on YYYYMMDD by [First and Last Name]
<Submitters: Please save the file using this naming convention: AUTHORLAST_readmeYYYYMMDD.txt>
-------------------
GENERAL INFORMATION
-------------------
1. Title of Dataset
2. Author Information
Principal Investigator Contact Information
Name:
Institution:
Address:
Email:
Associate or Co-investigator Contact Information
Name:
Institution:
Address:
Email:
Alternate Contact Information
Name:
Institution:
Address:
Email:
3. Date of data collection (single date, range, approximate date) <suggested format YYYYMMDD>
4. Geographic location of data collection (where was data collected?):
5. Information about funding sources that supported the collection of the data:
--------------------------
SHARING/ACCESS INFORMATION
--------------------------
1. Licenses/restrictions placed on the data:
2. Links to publications that cite or use the data:
3. Links to other publicly accessible locations of the data:
4. Links/relationships to ancillary data sets:
5. Was data derived from another source?
If yes, list source(s):
6. Recommended citation for the data:
---------------------
DATA & FILE OVERVIEW
---------------------
1. File List
A. Filename:
Short description:
B. Filename:
Short description:
C. Filename:
Short description:
2. Relationship between files:
3. Additional related data collected that was not included in the current data package:
4. Are there multiple versions of the dataset? yes/no
If yes, list versions:
Name of file that was updated:
i. Why was the file updated?
ii. When was the file updated?
Name of file that was updated:
i. Why was the file updated?
ii. When was the file updated?
--------------------------
METHODOLOGICAL INFORMATION
--------------------------
1. Description of methods used for collection/generation of data:
<Include links or references to publications or other documentation containing experimental design or protocols used in data collection>
2. Methods for processing the data: <describe how the submitted data were generated from the raw or collected data>
3. Instrument- or software-specific information needed to interpret the data:
4. Standards and calibration information, if appropriate:
5. Environmental/experimental conditions:
6. Describe any quality-assurance procedures performed on the data:
7. People involved with sample collection, processing, analysis and/or submission:
-----------------------------------------
DATA-SPECIFIC INFORMATION FOR: [FILENAME]
-----------------------------------------
<create sections for each dataset (or file if appropriate) included>
1. Number of variables:
2. Number of cases/rows:
3. Variable List
A. Name: [variable name]
Description: [description of the variable]
Value labels if appropriate
B. Name: [variable name]
Description: [description of the variable]
Value labels if appropriate
4. Missing data codes:
Code/symbol Definition
Code/symbol Definition
5. Specialized formats of other abbreviations used