comparison DVN-web/installer/dvninstall/doc/guides/dataverse-user-main.html @ 6:1b2188262ae9

adding the installer.
author "jurzua <jurzua@mpiwg-berlin.mpg.de>"
date Wed, 13 May 2015 11:50:21 +0200
parents
children
comparison
equal deleted inserted replaced
5:dd9adfc73390 6:1b2188262ae9
1
2
3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7 <html xmlns="http://www.w3.org/1999/xhtml">
8 <head>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10
11 <title>User Guide &mdash; The Harvard Dataverse Network 3.6.1 documentation</title>
12
13 <link rel="stylesheet" href="_static/agogo.css" type="text/css" />
14 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
15
16 <script type="text/javascript">
17 var DOCUMENTATION_OPTIONS = {
18 URL_ROOT: './',
19 VERSION: '3.6.1',
20 COLLAPSE_INDEX: false,
21 FILE_SUFFIX: '.html',
22 HAS_SOURCE: true
23 };
24 </script>
25 <script type="text/javascript" src="_static/jquery.js"></script>
26 <script type="text/javascript" src="_static/underscore.js"></script>
27 <script type="text/javascript" src="_static/doctools.js"></script>
28 <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
29 <link rel="top" title="The Harvard Dataverse Network 3.6.1 documentation" href="index.html" />
30 <link rel="next" title="Installers Guide" href="dataverse-installer-main.html" />
31 <link rel="prev" title="Dataverse Network Guides" href="index.html" />
32 </head>
33 <body>
34 <div class="header-wrapper">
35 <div class="header">
36 <div class="headertitle"><a
37 href="index.html">The Harvard Dataverse Network 3.6.1 documentation</a></div>
38 <div class="rel">
39 <a href="index.html" title="Dataverse Network Guides"
40 accesskey="P">previous</a> |
41 <a href="dataverse-installer-main.html" title="Installers Guide"
42 accesskey="N">next</a> |
43 <a href="genindex.html" title="General Index"
44 accesskey="I">index</a>
45 </div>
46 </div>
47 </div>
48
49 <div class="content-wrapper">
50 <div class="content">
51 <div class="document">
52
53 <div class="documentwrapper">
54 <div class="bodywrapper">
55 <div class="body">
56
57 <div class="section" id="user-guide">
58 <h1>User Guide<a class="headerlink" href="#user-guide" title="Permalink to this headline">¶</a></h1>
59 <div class="section" id="common-tasks">
60 <h2>Common Tasks<a class="headerlink" href="#common-tasks" title="Permalink to this headline">¶</a></h2>
61 <p>Here is a list of the most common ways people use the Dataverse Network.
62 Activities can be grouped into finding and using data or publishing
63 data. A brief description of each activity follows with more detailed
64 information available in the Users Guide.</p>
65 <div class="section" id="finding-data">
66 <h3>Finding Data<a class="headerlink" href="#finding-data" title="Permalink to this headline">¶</a></h3>
67 <p>Visitors to the site can browse dataverses looking for data of
68 interest or they can search by keywords. There are Basic and Advanced
69 Searches.</p>
70 <p><strong>Browsing the Site</strong></p>
71 <p>The Network Homepage presents a list of recently released dataverses on the left side of the page.
72 A dataverse is a container for studies that can be managed as a group by the dataverse administrator.
73 Most often a dataverse represents a single organization or scholar and so their studies are often related.
74 On the right side of the page there are lists of both recently released studies and studies that have been
75 downloaded most often. At the bottom of these lists, the View More link brings the user to a complete list
76 of released dataverses or studies as applicable. The home page also includes a scrolling list of datverse
77 collections called subnetworks, if applicable.</p>
78 <p>Clicking on the name of a dataverse, study or subnetwork displays its home page.</p>
79 <p><strong>Browsing Dataverses</strong></p>
80 <p>If you click the View More link under the recently released dataverse list on the Network Homepage you&#8217;ll be brought to
81 the Browse Dataverses page. Here you can sort the dataverses by Name, Affiliation, Release Date and Download Count. You
82 may also filter the dataverses by typing a filter term in the &#8220;filter&#8221; text box. The filter will only display those
83 dataverses whose name or affiliation matches the filter term. Clicking on the name of a dataverse displays its home page.</p>
84 <p><strong>Search</strong></p>
85 <p>For many purposes, Basic Search is sufficient. On the center top of the network homepage enter keywords or
86 complete sentences and click <strong>Search</strong>. A resulting list of studies is
87 displayed. Further refinement can be made by clicking facets such as
88 &#8220;Original Dataverse&#8221; or &#8220;Author&#8221; under &#8220;Refine Results&#8221; on the left side
89 of the page. After a facet has been clicked, it will appear at the top
90 of the page under &#8220;Search Results for&#8221; and clicking the selected facet
91 will remove it, restoring the previous results. In addition to the
92 network homepage, Basic Search can be found on the upper right of the
93 dataverse home pages as well as on the search results and Advanced
94 Search pages. Be aware that searching from a dataverse limits the scope
95 of search to studies within that dataverse while searching from the
96 network home page searches all released studies.</p>
97 <p>When a more specific search is needed, use Advanced Search. Advanced
98 Search allows searching on keywords found in specific cataloging
99 information fields, in particular collections in a dataverse where
100 available, or by variable name. The link to Advanced Search is next to
101 the Basic Search feature on the network and dataverse home pages and the
102 search results page.</p>
103 </div>
104 <div class="section" id="using-data">
105 <h3>Using Data<a class="headerlink" href="#using-data" title="Permalink to this headline">¶</a></h3>
106 <p>Data in the Dataverse Network is stored in files. Files of any
107 type are allowed but some types of tabular and network data files are
108 supported by additional functionality, including downloading in
109 different formats, downloading subsets of variables, and analytical
110 tools.</p>
111 <p><strong>Download Files</strong></p>
112 <p>To download files, click on a study of interest, then select the
113 data tab. Individual files can be downloaded or groups of files by
114 checking files of interest or entire file categories and clicking
115 Download All Selected Files. Groups of files are packaged into a single
116 <tt class="docutils literal"><span class="pre">.zip</span></tt> file. Group downloads have a download size limit and any selected
117 files not downloaded will be indicated in the <tt class="docutils literal"><span class="pre">.zip</span></tt> file.</p>
118 <p>Downloading individual files in an alternate format where available is
119 straightforward. Choose the format from the Download As select box next
120 to the file and the file will download.</p>
121 <p><strong>Subset or Analyze Files</strong></p>
122 <p>Tabular and Network data files of recognized formats (Stata, SPSS, RData,
123 Graphml) can be further manipulated through downloading subsets of
124 variables and by performing various statistical analyses. Where
125 available these options appear as an additional link, Access
126 Subset/Analysis, below the Download As format select box next to each
127 file. The functionality is quite different for tabular versus network
128 data files so refer to the Users Guide for additional information.</p>
129 </div>
130 <div class="section" id="publishing-data">
131 <h3>Publishing Data<a class="headerlink" href="#publishing-data" title="Permalink to this headline">¶</a></h3>
132 <p>Publishing data through the Dataverse Network is straightforward:
133 create an account and a place to store your data, organize your data,
134 upload files, and release your data for public access.</p>
135 <p><strong>Create a Dataverse and Account</strong></p>
136 <p>The first step to publishing your data is to create a place to
137 store it that can be managed by you. To do this you need an account.
138 Create a dataverse and account by clicking on the Create a Dataverse
139 link on the upper right side of the network homepage. This leads you
140 through a series of steps at the end of which you will have a dataverse
141 and user account to manage it.</p>
142 <p>Newly created dataverses are unreleased and not available for
143 browsing. Make note of the link to your dataverse at the end of the
144 process so you can return to it until it becomes released. Another way
145 to access your unreleased dataverse is to log in, click on your user
146 name in the upper right of the page, dataverses tab, then the name of
147 your dataverse.</p>
148 <p><strong>Create Studies</strong></p>
149 <p>Once you have a user account and a place to store your data, you
150 need to take the first step toward organizing your data into studies.
151 Many data have been or will be used to publish a study so this step may
152 be clear. If not, a study should represent a particular thesis or
153 inquiry with accompanying data. First, log in with your new user account
154 and navigate to your dataverse home page. Next, click Options in the
155 upper right of the page. From there click Create a Study and complete
156 the form. Most of the fields on the study form are optional -only the
157 title is required. If you are unsure of what these values should be,
158 enter a title and these fields can be completed later before releasing
159 the study.</p>
160 <p>Be aware that a newly created study is unreleased and not available
161 for browsing. To access an unreleased study for further editing, click
162 on Options-&gt;Manage Studies and click on your study&#8217;s name. You can also
163 click on your username, studies tab, then the study name.</p>
164 <p><strong>Upload Files</strong></p>
165 <p>Now that you have a place to store and manage your data and a
166 study to associate it with, you can upload your data and documentation
167 files. Files are uploaded to a study. Navigate to the study you want to
168 upload particular files to and click on Add Files on the upper right
169 side of the page. The add files page requires you to first select a file
170 type, then browse for the file on your local system. Some file types
171 undergo additional processing to support extended functionality but if
172 you are unsure which type to choose, select Other. At this time you can
173 enter a descriptive Category which can be used to group related files
174 and a file description. If you are unsure of these values they can be
175 added later.</p>
176 <p>Though files are selected individually, several files can be added
177 to this page at one time. It is recommended to upload only a few files
178 at a time since this can take some time to complete, depending on file
179 type.</p>
180 <p>An alternative to selecting files individually is to first create an
181 archive of files in <tt class="docutils literal"><span class="pre">.zip</span></tt> or <tt class="docutils literal"><span class="pre">.tar</span></tt> format and then select the
182 appropriate &#8220;multiple files&#8221; Data Type when uploading your archive. The
183 zip file or tarball will be unpacked so that the individual files will
184 be added to the page.</p>
185 <p>If you upload an SPSS (<tt class="docutils literal"><span class="pre">.por</span></tt>, <tt class="docutils literal"><span class="pre">.sav</span></tt>), Stata (<tt class="docutils literal"><span class="pre">.dta</span></tt>) or R
186 (<tt class="docutils literal"><span class="pre">.RData</span></tt>) file, your study will be temporarily unavailable for
187 editing until the additional processing on the file is completed. This
188 can be brief or take some time depending on the size and complexity of
189 the file. A message at the top of the file indicates it is unavailable
190 for editing and an email will be sent when finished to the address you
191 indicate on the add files page.</p>
192 <p><strong>Release Studies</strong></p>
193 <p>Once your study is in a state where it&#8217;s ready to be published or
194 shared with others, it should be released. This is done either by
195 clicking Release on the upper right of the study page or by navigating
196 to your dataverse, clicking Options, Manage Studies, then clicking
197 release next to the study you want released. Note that releasing a study
198 fixes the version number. Additional changes to the study will create a
199 new draft version. The draft can be repeatedly edited without changing
200 the version number until it is released. At this point your study is
201 visible within your dataverse. If your dataverse is also released it
202 will be searchable and viewable by others. If your dataverse is not yet
203 released, it will only be visible to people with access to your
204 dataverse.</p>
205 <p><strong>Release Dataverse</strong></p>
206 <p>Releasing a dataverse makes it appear in the list of dataverses on
207 the network home page and makes it viewable by others. This may require
208 adding a study or other details to your dataverse depending on site
209 policy. By default, releasing a dataverse requires nothing but changing
210 the Dataverse Release Settings to Released on the Manage Permissions
211 page. To release your dataverse, navigate to the dataverse home page,
212 choose Options from the upper right of the page, click on Dataverse
213 Settings, then Manage Permissions. At the top of the page, change
214 Dataverse Release Settiings to Released and click Save Changes.</p>
215 <p>Any studies that are released are now visible to others. Those
216 that are unreleased do not appear in the list of studies on the
217 dataverse home page.</p>
218 <p>At this point you have published one or more studies and their data and
219 made them available for browsing or searching.</p>
220 </div>
221 <div class="section" id="things-to-consider-next-steps">
222 <h3>Things to Consider, Next Steps<a class="headerlink" href="#things-to-consider-next-steps" title="Permalink to this headline">¶</a></h3>
223 <p>The above tasks are fundamental activities and may be all that is
224 needed for most users. Some situations are more complex and require
225 additional consideration. These include publishing and organizing data
226 for large organizations, shared research between scholars, and enabling
227 contributions by a geographically diverse team while keeping data
228 private until ready for publication.</p>
229 <p>For <strong>large organizations</strong>, a single dataverse may suffice. Collections
230 within a dataverse can further organize studies by sub unit or topic.
231 The dataverse itself can be <strong>customized</strong> with the organizations own
232 website header and footer. In some cases, sub units or organizations
233 want to maintain their own distinct branding. In such cases each can
234 create and maintain their own dataverse and the parent dataverse can
235 link to their studies through a link collection.</p>
236 <p>For <strong>shared research</strong>, the model is similar: a single dataverse based
237 on the research project can be created to which both researchers have
238 administration rights. Additionally, researchers can maintain their own
239 dataverses for other work and link back to the studies in the shared
240 project dataverse.</p>
241 <p><strong>Allowing a diverse team to contribute</strong> to an unreleased dataverse is
242 simply a matter of granting the appropriate level of <strong>permissions</strong> to
243 each team member. At minimum, each team member would need to be added as
244 a contributor to the dataverse. By default, they can only contribute to
245 studies they themselves have created. However, this can be expanded from
246 the dataverse Manage Permissions page to allow contributors to edit all
247 studies in the dataverse. Changes made by contributors need to be
248 approved by a curator or admin before a study can be released.</p>
249 </div>
250 <div class="section" id="how-the-guides-are-organized">
251 <h3>How the Guides Are Organized<a class="headerlink" href="#how-the-guides-are-organized" title="Permalink to this headline">¶</a></h3>
252 <p>The guides are reference documents that explain how to use
253 the Dataverse Network functionality: Installers Guide, Developers Guide, APIs Guide, and Users
254 Guide. The Users Guide is further divided into primary activities: using
255 data, creating studies, administering dataverses or the network. Details
256 on all of the above tasks can be found in the Users Guide. The
257 Installers Guide is for people or organizations who want to host their
258 own Dataverse Network. The Developers Guide contains instructions for
259 people who want to contribute to the Open Source Dataverse Network
260 project or who want to modify the code to suit their own needs. Finally, the
261 APIs Guide is for people who would like to use our APIs in order to build apps that
262 can work with the Dataverse Network web application. This <a class="reference external" href="http://thedata.org/book/apps">page</a> lists some current apps
263 which have been developed with our APIs.</p>
264 </div>
265 <div class="section" id="other-resources">
266 <h3>Other Resources<a class="headerlink" href="#other-resources" title="Permalink to this headline">¶</a></h3>
267 <p><strong>Dataverse Network Project Site</strong></p>
268 <p>Additional information about the Dataverse Network project itself
269 including presentations, information about upcoming releases, data
270 management and citation, and announcements can be found at
271 <a class="reference external" href="http://thedata.org/">http://thedata.org</a></p>
272 <p><strong>User Group</strong></p>
273 <p>As the user community grows we encourage people to shares ideas, ask
274 questions, or offer suggestions for improvement. Go to
275 <a class="reference external" href="https://groups.google.com/group/dataverse-community">https://groups.google.com/group/dataverse-community</a> to register to our dataverse community group.</p>
276 <p><strong>Follow Us on Twitter</strong></p>
277 <p>For up to date news, information and developments, follow our twitter account: <a class="reference external" href="https://twitter.com/thedataorg">https://twitter.com/thedataorg</a></p>
278 <p><strong>Support</strong></p>
279 <p>We maintain an email based support service that&#8217;s free of charge. We
280 attempt to respond within one business day to all questions and if it
281 cannot be resolved immediately, we&#8217;ll let you know what to expect.</p>
282 </div>
283 <div class="section" id="contact-us">
284 <h3>Contact Us<a class="headerlink" href="#contact-us" title="Permalink to this headline">¶</a></h3>
285 <p>The support email address is
286 <a class="reference external" href="mailto:support&#37;&#52;&#48;thedata&#46;org">support<span>&#64;</span>thedata<span>&#46;</span>org</a>.</p>
287 <p>This is the same address as the Report Issue link. We try to respond
288 within one business day.</p>
289 </div>
290 </div>
291 <div class="section" id="finding-and-using-data">
292 <span id="id1"></span><h2>Finding and Using Data<a class="headerlink" href="#finding-and-using-data" title="Permalink to this headline">¶</a></h2>
293 <p>Ends users, without need to login to the Dataverse Network, can browse
294 dataverses, search studies, view study description and data files for
295 public studies, and subset, analyze and visualize data for public data
296 files. If entire studies or individual data files are restricted, end
297 users need to be given permission from the dataverse administrator to
298 access the data.</p>
299 <div class="section" id="search">
300 <h3>Search<a class="headerlink" href="#search" title="Permalink to this headline">¶</a></h3>
301 <p>To find a study or data set, you can search or browse studies offered
302 in any released dataverse on the Network homepage. Each dataverse offers
303 a hierarchical organization comprising one or more collections of data
304 sets with a particular theme. Most dataverses allow you to search for
305 data within their files, or you can start browsing through the dataverse
306 classifications that are closest to your substantive interests.</p>
307 <p><strong>Browse Collections</strong></p>
308 <p>You can browse all public dataverses from the Network homepage. Click
309 the title of a dataverse to browse that dataverse&#8217;s collections and
310 studies. Click the title of a collection to view a list of studies and
311 subcollections for that selection. Click the title of a study to view
312 the Cataloging Information and study files for that selection.</p>
313 <p>When you select a dataverse to view its contents, the homepage opens to
314 the&nbsp;<em>root collection</em>, and the dataverse&#8217;s studies are displayed
315 directly under the root collection name. If the root collection contains
316 other collections, then those collections are listed and not the studies
317 within them. You must select a collection title to view the studies
318 contained within it.</p>
319 <p>Note: If a dataverse includes links to collections from another
320 dataverse and the root collection does not contain other collections,
321 the homepage opens to a list of the root and linked collections.</p>
322 <p><strong>Search - Basic</strong></p>
323 <p>You can search for studies across the entire Dataverse Network from the
324 Network homepage, or search within a dataverse from the dataverse
325 homepage. When you search across the Network, studies from restricted
326 dataverses are not included in the search. Restricted studies are
327 included in search results, and a lock icon appears beside those studies
328 in the results list. After your search is complete, you can further
329 narrow your list of data by searching again in the results. See Search
330 Tips for search examples and guidelines.</p>
331 <p>When you enter more than one term in the search text field, the results
332 list contains studies that have these terms near each other within the
333 study fields searched. For example, if you enter <tt class="docutils literal"><span class="pre">United</span> <span class="pre">Nations</span></tt>,
334 the results include studies where the words <em>United</em> and <em>Nations</em> are
335 separated by no more than four words in the same study field, such as
336 abstract or title.</p>
337 <p>It supports a search in any field of the studies&#8217; Cataloging
338 Information, which includes citation information, abstract and other
339 scope-related information, methodology, and Terms of Use. In addition,
340 file descriptions also are searched.</p>
341 <p><strong>Search - Advanced</strong></p>
342 <p>In an advanced search, you can refine your criteria by choosing which
343 Cataloging Information fields to search. You also can apply logic to the
344 field search. For text fields, you can specify that the field searched
345 either <em>contains</em> or <em>does not containthe text that you enter. For
346 date fields, you can specify that the field searched is either *later
347 than</em> nor <em>earlier than</em> the date that you enter. Refer to
348 the <a class="reference external" href="http://lucene.apache.org/java/docs/">Documentation</a> page for
349 the latest version at the Lucene website and look for <em>Query Syntax</em> for full details.</p>
350 <p>To perform an advanced search, click the Advanced Search link at the
351 top-right of the Search panel. You can search the following study
352 metadata fields by using the Search Scope drop-down list:</p>
353 <ul class="simple">
354 <li>Title - Title field of studies&#8217; Cataloging Information.</li>
355 <li>Author - Author fields of studies&#8217; Cataloging Information.</li>
356 <li>(Study) Global ID - ID assigned to studies.</li>
357 <li>Other ID - A different ID previously given to the study by another
358 archive.</li>
359 <li>Abstract - Any words in the abstract of the study.</li>
360 <li>Keyword - A term that defines the nature or scope of a study. For
361 example, <tt class="docutils literal"><span class="pre">elections</span></tt>.</li>
362 <li>Keyword Vocabulary - Reference to the standard used to define the
363 keywords.</li>
364 <li>Topic Classification - One or more words that help to categorize the
365 study.</li>
366 <li>Topic Classification Vocabulary - Reference used to define the Topic
367 Classifications.</li>
368 <li>Producer - Institution, group, or person who produced the study.</li>
369 <li>Distributor - Institution that is responsible for distributing the
370 study.</li>
371 <li>Funding Agency - Agency that funded the study.</li>
372 <li>Production Date - Date on which the study was created or completed.</li>
373 <li>Distribution Date - Date on which the study was distributed to the
374 public.</li>
375 <li>Date of Deposit - Date on which the study was uploaded to the
376 Network.</li>
377 <li>Time Period Cover Start - The beginning of the period covered by the
378 study.</li>
379 <li>Time Period Cover End - The end of the period covered by the study.</li>
380 <li>Country/Nation - The country or countries where the study took place.</li>
381 <li>Geographic Coverage - The geographical area covered by the study. For
382 example, <tt class="docutils literal"><span class="pre">North</span> <span class="pre">America</span></tt>.</li>
383 <li>Geographic Unit - The smallest geographic unit in which the study
384 took place, such as <tt class="docutils literal"><span class="pre">state</span></tt>.</li>
385 <li>Universe - Universe of interest, population of interest, or target
386 population.</li>
387 <li>Kind of Data - The type of data included in the file, such
388 as <tt class="docutils literal"><span class="pre">survey</span> <span class="pre">data</span></tt>, <tt class="docutils literal"><span class="pre">census/enumeration</span> <span class="pre">data</span></tt>,
389 or <tt class="docutils literal"><span class="pre">aggregate</span> <span class="pre">data</span></tt>.</li>
390 <li>Variable Information - The variable name and description in the
391 studies&#8217; data files, given that the data file is subsettable and
392 contains tabular data. It returns the studies that contain the file
393 and the variable name where the search term was found.</li>
394 </ul>
395 <p><strong>Sort Results</strong></p>
396 <p>When your search is complete, the results page lists studies that met
397 the search criteria in order of relevance. For example, a study that
398 includes your search term within the Cataloging Information in ten
399 places appears before a study that includes your search term in the
400 Cataloging Information in only one place.</p>
401 <p>You can sort search results by title, study ID, last updated, or number
402 of downloads (that is, the number of times users downloaded any file
403 belonging to that study). Click the Sort By drop-down list to choose
404 your sort order.</p>
405 <p><strong>Search Tips</strong></p>
406 <p>Use the following guidelines to search effectively within a Network or a
407 dataverse:</p>
408 <ul>
409 <li><p class="first">The default search syntax uses <tt class="docutils literal"><span class="pre">AND</span></tt> logic within individual
410 fields. That is, if you enter more than one term, the search engine
411 looks for all terms within a single field, such as title or abstract.
412 For example, if you enter <tt class="docutils literal"><span class="pre">United</span> <span class="pre">Nations</span> <span class="pre">report</span></tt>, the results
413 list any studies that include the terms <em>United</em>, <em>Nations</em>,
414 and <em>report</em> within a single metadata field.</p>
415 </li>
416 <li><p class="first">The search logic looks for multiple terms within a specific proximity
417 to one another, and in the same field. The current proximity criteria
418 is four words. That is, if you enter two search terms, both terms
419 must be within four words of each other in the same field to be
420 returned as a result.
421 For example, you might enter <tt class="docutils literal"><span class="pre">10</span> <span class="pre">year</span></tt> in a basic search. If a
422 study includes the string <em>10 millions deaths per year</em> within a
423 metadata field, such as abstract, that study is not included in the
424 search results. A study that contains the string <em>10 per year</em> within the abstract field is included in the search results.</p>
425 </li>
426 <li><p class="first">During the index process that supports searches, periods are removed
427 in strings and each term between periods is indexed individually. If
428 you perform a basic search for a term that contains one or more
429 periods, the search works because the analyzer applies
430 the <em>AND</em> logic. If you search on a specific field, though, note
431 that you should specify individually each component of the string
432 between periods to return your results.</p>
433 </li>
434 <li><p class="first">You can enter one term in the search field, and then search within
435 those results for another term to narrow the results further. This
436 might be more effective than searching for both terms at one time, if
437 those terms do not meet the proximity and field limits specified
438 previously.
439 You could search first for an author&#8217;s name, and then search those
440 results for a specific term in the title. If you try searching for
441 both terms in the author and title fields together, you might not
442 find the study for which you are looking.
443 For example, you can search the Harvard Dataverse Network for the
444 following study:</p>
445 <blockquote>
446 <div><p><em>Gary King; Will Lowe, 2003, &#8220;10 Million International Dyadic
447 Events&#8221;, hdl:1902.1/FYXLAWZRIA UNF:3:um06qkr/1tAwpS4roUqAiw==
448 Murray Research Archive [Distributor]</em></p>
449 </div></blockquote>
450 <p>If you type <tt class="docutils literal"><span class="pre">King,</span> <span class="pre">10</span> <span class="pre">Million</span></tt> in the Search field and click
451 Search, you see <tt class="docutils literal"><span class="pre">0</span> <span class="pre">matches</span> <span class="pre">were</span> <span class="pre">found</span></tt> in the Results field. If
452 you type <tt class="docutils literal"><span class="pre">10</span></tt> in the Search field and click Search, you see
453 something like <tt class="docutils literal"><span class="pre">1621</span> <span class="pre">matches</span> <span class="pre">were</span> <span class="pre">found</span></tt> in the Results field.
454 But if you first type <tt class="docutils literal"><span class="pre">King</span></tt> in the Search field and click
455 Search, then type <tt class="docutils literal"><span class="pre">10</span> <span class="pre">Million</span></tt> in the Search field and click
456 Search again, you see something like <tt class="docutils literal"><span class="pre">4</span> <span class="pre">matches</span> <span class="pre">were</span> <span class="pre">found</span></tt> in the
457 Results field.</p>
458 </li>
459 </ul>
460 </div>
461 <div class="section" id="view-studies-download-data">
462 <h3>View Studies / Download Data<a class="headerlink" href="#view-studies-download-data" title="Permalink to this headline">¶</a></h3>
463 <p><strong>Cataloging Information</strong></p>
464 <p>When a study is created, a set of <em>metadata</em> is associated with that
465 study. This metadata is called the <em>Cataloging Information</em> for the
466 study. When you select a study to view it, you first see the Cataloging
467 Information tab listing the metadata associated with that study. This is
468 the default view of a study.</p>
469 <p>Cataloging Information contains numerous fields that help to describe
470 the study. The amount of information you find for each study varies,
471 based on what was entered by the author (Contributor) or Curator of that
472 study. For example, one study might display the distributor, related
473 material, and geographic coverage. Another study might display only the
474 authors and the abstract. Every study includes the <em>Citation Information</em> fields in the Cataloging Information.</p>
475 <p>Note: A comprehensive list of all Cataloging Information fields is
476 provided in the <a class="reference internal" href="#metadata-references"><em>List of Metadata References</em></a></p>
477 <p>Cataloging Information is divided into four sections. These sections and
478 their details are displayed only when the author (Contributor) or
479 Curator provides the information when creating the study. Sections
480 consist of the following:</p>
481 <ul class="simple">
482 <li>Citation Information - These fields comprise
483 the <a class="reference external" href="http://thedata.org/citation">citation</a> for the study,
484 consisting of a global identifier for all studies and a UNF, or
485 Universal Numerical Fingerprint, for studies that contain subsettable
486 data files. It also can include information about authors, producers
487 and distributors, and references to related studies or papers.</li>
488 <li>Abstract and Scope - This section describes the research study, lists
489 the study&#8217;s data sets, and defines the study&#8217;s geographical scope.</li>
490 <li>Data Collection/Methodology - This section includes the technical
491 details of how the author obtained the data.</li>
492 <li>Terms of Use - This information explains that the study requires
493 users to accept a set of conditions or agreements before downloading
494 or analyzing the data. If any <em>Terms of Use</em> text is displayed in
495 the Cataloging Information section, you are prompted to accept the
496 conditions when you click the download or analyze icons in the Files
497 page.
498 Note: A study might not contain Terms of Use, but in some cases the
499 original parent dataverse might have set conditions for all studies
500 owned by that dataverse. In that case, the conditions are inherited
501 by the study and you must accept these conditions before downloading
502 files or analyzing the data.</li>
503 </ul>
504 <p>Study metadata can be downloaded in XML format using a link at the bottom
505 of the study Cataloging Information tab: <a class="reference external" href="https://thedata.harvard.edu/dvn/api/metadata/91148?partialExclude=codeBook/dataDscr">DDI (without variables)</a>
506 / <a class="reference external" href="https://thedata.harvard.edu/dvn/api/metadata/91148">DDI (full)</a>.
507 These links appear for released studies whose metadata has been exported.
508 Studies are typically exported on a daily basis.</p>
509 <p><strong>List of Study Files</strong></p>
510 <p>When you view a study, click the Documentation, Data and Analysis tab to
511 view a list of all electronic files associated with the study that were
512 provided by the author or Curator.</p>
513 <p>A study might contain documentation, data, or other files. When the
514 study contributor uploads data files of the type <tt class="docutils literal"><span class="pre">.dta</span></tt>, <tt class="docutils literal"><span class="pre">.sav</span></tt>, or <tt class="docutils literal"><span class="pre">.por</span></tt> to the Network, those files are converted
515 to <tt class="docutils literal"><span class="pre">.tab</span></tt> tab-delimited files. These <tt class="docutils literal"><span class="pre">.tab</span></tt> files
516 are subsettable, and can be subsetted and analyzed online by using the Dataverse Network
517 application.</p>
518 <p>Data files of the type <tt class="docutils literal"><span class="pre">.xml</span></tt> also are considered to be subsettable,
519 and can be subsetted and analyzed to a minimal degree online.
520 An <tt class="docutils literal"><span class="pre">.xml</span></tt> type file indicates social network data that complies with
521 the <a class="reference external" href="http://graphml.graphdrawing.org/">GraphML</a> file format.</p>
522 <p>You can identify a subsettable data file by the <em>Subsetting</em> label and
523 the number of cases and variables listed next to the file name. Other
524 files that also contain data might be associated with a study, but the
525 Dataverse Network application does not recognize them as data (or
526 subsettable) files.</p>
527 <p><strong>Download Study Files</strong></p>
528 <p>You can download any of the following within a study:</p>
529 <ul class="simple">
530 <li>All or selected data files within a <em>study</em> or a <em>category</em> (type
531 of files)</li>
532 <li>Individual <em>data files</em></li>
533 <li>Individual subsets within a data file (see <a class="reference internal" href="#tabular-data"><em>Subset and Analyze
534 Tabular Data Sets</em></a>
535 or <a class="reference internal" href="#network-data"><em>Subset and Analyze Network Data Sets</em></a> for details)</li>
536 </ul>
537 <p>The default format for subsettable tabular data file downloads
538 is <em>tab-delimited</em>. When you download one or more subsettable files in
539 tab-delimited format, the file contains a header row. When you download
540 one subsettable file, you can select from the following formats in
541 addition to tab-delimited:</p>
542 <ul class="simple">
543 <li>Original file</li>
544 <li>Splus</li>
545 <li>Stata</li>
546 <li>R</li>
547 </ul>
548 <p>The default format for subsettable network data file downloads
549 is <em>Original file</em>. In addition, you can choose to download network
550 data files in <em>GraphML</em> format.</p>
551 <p>If you select any other format for a tabular data file, the file is
552 downloaded in a zipped archive. You must unzip the archive to view or
553 use the individual data file.</p>
554 <p>If you download all or a selection of data files within a study, the
555 files are downloaded in a zipped archive, and the individual files are
556 in tab-delimited or network format. You must unzip the archive to view
557 or use the individual data files.</p>
558 <p>Note: Studies and data files often have user restrictions applied. If
559 prompted to accept Terms of Use for a study or file, check the <em>I Accept</em> box and then click the Continue button to view or download the
560 file.</p>
561 <p><strong>User Comments</strong></p>
562 <p>If the User Comment feature is enabled within a dataverse, users are
563 able to add comments about a study within that dataverse.</p>
564 <p>When you view a study, click the User Comments tab to view all comments
565 associated with the study. Comments can be monitored and abuse reported
566 to the Network admin, who has permission to remove any comments deemed
567 inappropriate. Note that the dataverse admin does not have permission to
568 remove comments, to prevent bias.</p>
569 <p>If you choose, you also can add your own comments to a study from the
570 User Comments tab. See <a class="reference internal" href="#edit-study-comments-settings"><em>Comment on Studies or Data</em></a> for
571 detailed information.</p>
572 <p>Note: To add a comment to a study, you must register and create an
573 account in the dataverse that owns the study about which you choose to
574 comment. This helps to prevent abuse and SPAM issues.</p>
575 <p><strong>Versions</strong></p>
576 <p>Upon creating a study, a version is created. This is a way to archive
577 the&nbsp;<em>metadata</em> and&nbsp;<em>data files</em>&nbsp;associated with the study citation
578 or UNF.</p>
579 <p><strong>View Citations</strong></p>
580 <p>You can view a formatted citation for any of the following entities
581 within the Dataverse Network application:</p>
582 <ul class="simple">
583 <li>Studies - For every study, you can view a citation for that study.
584 Go to the Cataloging Information tab for a study and view the&nbsp;<em>How
585 to Cite</em> field.</li>
586 <li>Data sets - For any data set, you can view a citation for that set.
587 Go to the Documentation, Data and Analysis tab for a study to see the
588 list of study files. To view the citation for any data set click
589 the&nbsp;<em>View Data Citation</em> link associated with that subsettable
590 file.</li>
591 <li>Data subsets - If you subset and analyze a data set, you can view a
592 citation for each subset.
593 See <a class="reference internal" href="#apply-descriptive-statistics"><em>Apply Descriptive Statistics</em></a> or <a class="reference internal" href="#perform-advanced-analysis"><em>Perform Advanced Analysis</em></a> for
594 detailed information.
595 Also, when you download a workspace file, a copy
596 of the citation information for that subset is provided in the
597 download.</li>
598 </ul>
599 <p>Note: For individual variables within a subsettable data subset, you can
600 view the <a class="reference external" href="http://thedata.org/citation/tech">UNF</a> for that variable.
601 This is not a full citation for the variable, but it is one component of
602 that citation. Note also that this does not apply to <tt class="docutils literal"><span class="pre">.xml</span></tt> data.</p>
603 </div>
604 <div class="section" id="subset-and-analysis">
605 <h3>Subset and Analysis<a class="headerlink" href="#subset-and-analysis" title="Permalink to this headline">¶</a></h3>
606 <p>Subsetting and analysis can be performed on tabular and network data
607 files. Refer to the appropriate section for more details.</p>
608 <div class="section" id="tabular-data">
609 <span id="id2"></span><h4>Tabular Data<a class="headerlink" href="#tabular-data" title="Permalink to this headline">¶</a></h4>
610 <p>Tabular data files (subsettable files) can be subsetted and analyzed
611 online by using the Dataverse Network application. For analysis, the
612 Dataverse Network offers a user interface to Zelig, a powerful, R-based
613 statistical computing tool. A comprehensive set of Statistical Analysis
614 Models are provided.</p>
615 <p>After you find the tablular data set that you want, access the Subset
616 and Analysis options to use the online tools. Then, you can&nbsp;<em>subset
617 data by variables or observations</em>, translate it into a convenient
618 format, download subsets, and apply statistics and analysis.</p>
619 <p>Network data files (also subsettable) can be subsetted online, and then
620 downloaded as a subset. Note that network data files cannot be analyzed
621 online.</p>
622 <p>Review the Tabular Data Subset and Recode Tips before you start.</p>
623 <p><strong>Access Subset and Analysis Options</strong></p>
624 <p>You can subset and analyze tabular data files before you download the
625 file or your subsets.</p>
626 <p>To access the Subset and Analysis options for a data set:</p>
627 <ol class="arabic simple">
628 <li>Click the title of the study from which you choose to analyze or
629 download a file or subset.</li>
630 <li>Click the Documentation, Data and Analysis tab for the study.</li>
631 <li>In the list of study files, locate the data file that you choose to
632 download, subset, or analyze.
633 You can download data sets for a file only if the file entry includes
634 the subset icon.</li>
635 <li>Click the <em>Access Subset/Analysis</em>&nbsp;link associated with the
636 selected file.
637 If prompted, check the <em>I accept</em> box and click Continue to accept
638 the Terms of Use.
639 You see the Data File page listing data for the file that you choose
640 to subset or analyze.</li>
641 </ol>
642 <p><strong>View Variable Quick Summary</strong></p>
643 <p>When a subsettable data file is uploaded for a study, the Dataverse
644 Network code calculates summary statistics for each variable within that
645 data file. On any tab of the Data File page, you can view the summary
646 statistics for each variable in the data file. Information listed
647 comprises the following:</p>
648 <ul class="simple">
649 <li>For continuous variables, the application calculates summary
650 statistics that are listed in the DDI schema.</li>
651 <li>For discrete variables, the application tabulates values and their
652 labels as a frequency table.
653 Note, however, that if the number of categories is more than 50, the
654 values are not tabulated.</li>
655 <li>The UNF value for each variable is included.</li>
656 </ul>
657 <p>To view summary statistics for a variable:</p>
658 <ol class="arabic simple">
659 <li>In the Data File page, click any tab.</li>
660 <li>In the variable list on the bottom of the page, the right column is
661 labeled <em>Quick Summary</em>.
662 locate a variable for which you choose to view summary statistics.
663 Then, click the Quick Summary icon for that variable to toggle the
664 statistic&#8217;s information on and off.
665 You see a small chart that lists information about that variable. The
666 information provided depends upon the variable selected.</li>
667 </ol>
668 <p><strong>Download Tabular Subsets</strong></p>
669 <p>You can download a subset of variables within a tabular-data study file.
670 You also can recode a subset of those variables and download the recoded
671 subset, if you choose.</p>
672 <p>To download a subset of variables in tabular data:</p>
673 <ol class="arabic simple">
674 <li>In the Data File page, click the Download Subset tab.</li>
675 <li>Click the radio button for the appropriate File Format in which to
676 download the variables: Text, R Data, S plus, or Stata.</li>
677 <li>On the right side of the tab, use the Show drop-down list to select
678 the quantities of variables to list at one time: 10, 20, 50, or All.</li>
679 <li>Scroll down the screen and click the check boxes to select variables
680 from the table of available values. When you select a variable, it is
681 added to the Selected Variables box at the top of the tab.
682 To remove a variable from this box, deselect it from the Variable
683 Type list at the bottom of the screen.
684 To select all variables, click the check box beside the column name,
685 Variable Type.</li>
686 <li>Click the <em>Create Zip File</em> button.
687 The <em>Create Zip File</em> button label changes the following
688 format: <tt class="docutils literal"><span class="pre">zipFile_&lt;number&gt;.zip</span></tt>.</li>
689 <li>Click the <tt class="docutils literal"><span class="pre">zipFile_&lt;number&gt;.zip</span></tt> button and follow your browser&#8217;s
690 prompts to open or save the data file to your computer&#8217;s disk drive</li>
691 </ol>
692 <p id="apply-descriptive-statistics"><strong>Apply Descriptive Statistics</strong></p>
693 <p>When you run descriptive statistics for data, you can do any of the
694 following with the analysis results:</p>
695 <ul class="simple">
696 <li>Open the results in a new window to save or print the results.</li>
697 <li>Download the R workspace in which the statistics were analyzed, for
698 replication of the analysis. See Replicate Analysis for more
699 information.</li>
700 <li>View citation information for the data analyzed, and for the full
701 data set from which you selected variables to analyze. See View
702 Citations for more information.</li>
703 </ul>
704 <p>To apply descriptive statistics to a data set or subset:</p>
705 <ol class="arabic simple">
706 <li>In the Data File page, click the Descriptive Statistics tab.</li>
707 <li>Click one or both of the Descriptive Statistics options: Univariate
708 Numeric Summaries and Univariate Graphic Summaries.</li>
709 <li>On the right side of the tab, use the Show drop-down list to select
710 one of the following options to show variables in predefined
711 quantities: 10, 20, 50, or All.</li>
712 <li>Scroll down the screen and click the check boxes to select variables
713 from the table of available values. When you select a variable, it is
714 added to the Selected Variables box at the top of the tab.
715 To remove a variable from this box, deselect it from the Variable
716 Type list at the bottom of the screen.
717 To select all variables, click the check box beside the column name,
718 Variable Type.</li>
719 <li>Click the Run Statistics button.
720 You see the Dataverse Analysis page.</li>
721 <li>To save or print the results, scroll to the Descriptive Statistics
722 section and click the link <em>Open results in a new window</em>. You then
723 can print or save the window contents.
724 To save the analysis, scroll to the Replication section and click the
725 button <em>zipFile_&lt;number&gt;.zip</em>.
726 Review the Citation Information for the data set and for the subset
727 that you analyzed.</li>
728 <li>Click the link <em>Back to Analysis and Subsetting</em> to return the
729 previous page and continue analysis of the data.</li>
730 </ol>
731 <p><strong>Recode and Case-Subset Tabular Data</strong></p>
732 <p>Review the Tabular Data Recode and Subset Tips before you start work
733 with a study&#8217;s files.</p>
734 <p>To recode and subset variables within a tabular data set:</p>
735 <ol class="arabic simple">
736 <li>In the Data File page, click the Recode and Case-Subsetting tab.</li>
737 <li>One the right side of the variable list, use the Show drop-down list
738 and select one of the following options to show variables in
739 predefined quantities: 10, 20, 50, or All.</li>
740 <li>Scroll down the screen and click the check boxes to select variables
741 from the table of available values. When you select a variable, it is
742 added to the Selected Variables box at the top of the tab.
743 To remove a variable from this box, deselect it from the Variable
744 Type list at the bottom of the screen.
745 To select all variables, click the check box beside the column name,
746 Variable Type.</li>
747 <li>Select one variable in the Selected Variables box, and then
748 click <em>Start</em>.
749 The existing name and label of the variable appear in the New
750 Variable Name and New Variable Label boxes.</li>
751 <li>In the New Variable Label field, change the variable name to a unique
752 value that is not used in the data file.
753 The new variable label is optional.</li>
754 <li>In the table below the Variable Name fields, you can check one or
755 more values to drop them from the subset, or enter new values,
756 labels, or ranges (as a condition) as needed. Click the Add
757 Value/Range button to create more entries in the value table.
758 Note: Click the <tt class="docutils literal"><span class="pre">?</span></tt> Info buttons to view tips on how to use the
759 Recode and Subset table. Also, See Tabular Data Recode and Subset
760 Tips for more information about adding values and ranges.</li>
761 <li>Click the Apply Recodes button.
762 Your renamed variables appear at the bottom of the page in the List
763 of Recode Variables.</li>
764 <li>Select another variable in the Selected Variables box, click the
765 Start button, and repeat the recode action.
766 Repeat this process for each variable that you choose to recode.</li>
767 <li>To remove a recoded variable, scroll to the List of Recode Variables
768 at the bottom of the page and click the Remove link for the recoded
769 variable that you choose to delete from your subset.</li>
770 </ol>
771 <p id="perform-advanced-analysis"><strong>Perform Advanced Analysis</strong></p>
772 <p>When you run advanced statistical analysis for data, you can do any of
773 the following with the analysis results:</p>
774 <ul class="simple">
775 <li>Open the results in a new window to save or print the results.</li>
776 <li>Download the R workspace in which the statistics were analyzed, for
777 replication of the analysis. See Replicate Analysis for more
778 information.</li>
779 <li>View citation information for the data analyzed, and for the full
780 data set from which you selected variables to analyze. See View
781 Citations for more information.</li>
782 </ul>
783 <p>To run statistical models for selected variables:</p>
784 <ol class="arabic simple">
785 <li>In the Data File page, click the Advanced Statistical Analysis tab.</li>
786 <li>Scroll down the screen and click the check boxes to select variables
787 from the table of available values. When you select a variable, it is
788 added to the Selected Variables box at the top of the tab.
789 To remove a variable from this box, deselect it from the Variable
790 Type list at the bottom of the screen.
791 To select all variables, click the check box beside the column name,
792 Variable Type.</li>
793 <li>Select a model from the Choose a Statistical Model drop-down list.</li>
794 <li>Select one variable in the Selected Variables box, and then click the
795 applicable arrow button to assign a function to that variable from
796 within the analysis model.
797 You see the name of the variables in the appropriate function box.
798 Note: Some functions allow a specific type of variable only, while
799 other functions allow multiple variable types. Types include
800 Character, Continuous, and Discrete. If you assign an incorrect
801 variable type to a function, you see an <tt class="docutils literal"><span class="pre">Incompatible</span> <span class="pre">type</span></tt> error
802 message.</li>
803 <li>Repeat the variable and function assignments until your model is
804 complete.</li>
805 <li>Select your Output options.</li>
806 <li>Click the Run Model button.
807 If the statistical model that you defined is incomplete, you first
808 are prompted to correct the definition. Correct your model, and then
809 click Run Model again.
810 You see the Dataverse Analysis page.</li>
811 <li>To save or print the results, scroll to the Advanced Statistical
812 Analysis section and click the link <em>Open results in a new window</em>.
813 You then can print or save the window contents.
814 To save the analysis, scroll to the Replication section and click the
815 button <tt class="docutils literal"><span class="pre">zipFile_&lt;number&gt;.zip</span></tt>.
816 Review the Citation Information for the data set and for the subset
817 that you analyzed.</li>
818 <li>Click the link <em>Back to Analysis and Subsetting</em> to return the
819 previous page and continue analysis of the data.</li>
820 </ol>
821 <p><strong>Replicate Analysis</strong></p>
822 <p>You can save the R workspace in which the Dataverse Network performed an
823 analysis. You can download the workspace as a zipped archive that
824 contains four files. Together, these files enable you to recreate the
825 subset analysis in another R environment:</p>
826 <ul class="simple">
827 <li><tt class="docutils literal"><span class="pre">citationFile.&lt;identifier&gt;.txt</span></tt> - The citation for the subset that you analyzed.</li>
828 <li><tt class="docutils literal"><span class="pre">rhistoryFile.&lt;identifier&gt;.R</span></tt> - The R code used to perform the analysis.</li>
829 <li><tt class="docutils literal"><span class="pre">tempsubsetfile.&lt;identifier&gt;.tab</span></tt> - The R object file used to perform the analysis.</li>
830 <li><tt class="docutils literal"><span class="pre">tmpRWSfile.&lt;identifier&gt;.RData</span></tt> - The subset data that you analyzed.</li>
831 </ul>
832 <p>To download this workspace for your analysis:</p>
833 <ol class="arabic simple">
834 <li>For any subset, Apply Descriptive Statistics or Perform Advanced
835 Analysis.</li>
836 <li>On the Dataverse Analysis or Advanced Statistical Analysis page,
837 scroll to the Replication section and click the
838 button <tt class="docutils literal"><span class="pre">zipFile_&lt;number&gt;.zip</span></tt>.</li>
839 <li>Follow your browser&#8217;s prompts to save the zipped archive.
840 When the archive file is saved to your local storage, extract the
841 contents to use the four files that compose the R workspace.</li>
842 </ol>
843 <p><strong>Statistical Analysis Models</strong></p>
844 <p>You can apply any of the following advanced statistical models to all or
845 some variables in a tabular data set:</p>
846 <p>Categorical data analysis: Cross tabulation</p>
847 <p>Ecological inference model: Hierarchical mulitnomial-direct ecological
848 inference for R x C tables</p>
849 <p>Event count models, for event count dependent variables:</p>
850 <ul class="simple">
851 <li>Negative binomial regression</li>
852 <li>Poisson regression</li>
853 </ul>
854 <p>Models for continuous bounded dependent variables:</p>
855 <ul class="simple">
856 <li>Exponential regression for duration</li>
857 <li>Gamma regression for continuous positives</li>
858 <li>Log-normal regression for duration</li>
859 <li>Weibull regression for duration</li>
860 </ul>
861 <p>Models for continuous dependent variables:</p>
862 <ul class="simple">
863 <li>Least squares regression</li>
864 <li>Linear regression for left-censoreds</li>
865 </ul>
866 <p>Models for dichotomous dependent variables:</p>
867 <ul class="simple">
868 <li>Logistic regression for binaries</li>
869 <li>Probit regression for binaries</li>
870 <li>Rare events logistic regression for binaries</li>
871 </ul>
872 <p>Models for ordinal dependent variables:</p>
873 <ul class="simple">
874 <li>Ordinal logistic regression for ordered categoricals</li>
875 <li>Ordinal probit regression for ordered categoricals</li>
876 </ul>
877 <p><strong>Tabular Data Recode and Subset Tips</strong></p>
878 <p>Use the following guidelines when working with tabular data files:</p>
879 <ul class="simple">
880 <li>Recoding:<ul>
881 <li>You must fill at least the first (new value) and last (condition)
882 columns of the table; the second column is optional and for a new
883 value label.</li>
884 <li>If the old variable you chose for recoding has information about
885 its value labels, you can prefill the table with these data for
886 convenience, and then modify these prefilled data.</li>
887 <li>To exclude a value from your recoding scheme, click the Drop check
888 box in the row for that value.</li>
889 </ul>
890 </li>
891 <li>Subsetting:<ul>
892 <li>If the variable you chose for subsetting has information about its
893 value labels, you can prefill the table with these data for
894 convenience.</li>
895 <li>To exclude a value in the last column of the table, click the Drop
896 check box in row for that value.</li>
897 <li>To include a particular value or range, enter it in the last
898 column whose header shows the name of the variable for subsetting.</li>
899 </ul>
900 </li>
901 <li>Entering a value or range as a condition for subsetting or recoding:<ul>
902 <li>Suppose the variable you chose for recoding is x.
903 If your condition is x==3, enter <tt class="docutils literal"><span class="pre">3</span></tt>.
904 If your condition is x &lt; -3, enter <tt class="docutils literal"><span class="pre">(--3</span></tt>.
905 If your condition is x &gt; -3, enter <tt class="docutils literal"><span class="pre">-3-)</span></tt>.
906 If your condition is -3 &lt; x &lt; 3, enter <tt class="docutils literal"><span class="pre">(-3,</span> <span class="pre">3)</span></tt>.</li>
907 <li>Use square brackets (<tt class="docutils literal"><span class="pre">[]</span></tt>) for closed ranges.</li>
908 <li>You can enter non-overlapping values and ranges separated by a
909 comma, such as <tt class="docutils literal"><span class="pre">0,[7-9]</span></tt>.</li>
910 </ul>
911 </li>
912 </ul>
913 </div>
914 <div class="section" id="network-data">
915 <span id="id3"></span><h4>Network Data<a class="headerlink" href="#network-data" title="Permalink to this headline">¶</a></h4>
916 <p>Network data files (subsettable files) can be subsetted and analyzed
917 online by using the Dataverse Network application. For analysis, the
918 Dataverse Network offers generic network data analysis. A list of
919 Network Analysis Models are provided.</p>
920 <p>Note: All subsetting and analysis options for network data assume a
921 network with undirected edges.</p>
922 <p>After you find the network data set that you want, access the Subset and
923 Analysis options to use the online tools. Then, you can subset data
924 by <em>vertices</em>&nbsp;or&nbsp;<em>edges</em>, download subsets, and apply network
925 measures.</p>
926 <p><strong>Access Network Subset and Analyze Options</strong></p>
927 <p>You can subset and analyze network data files before you download the
928 file or your subsets. To access the Subset and Analysis options for a
929 network data set:</p>
930 <ol class="arabic simple">
931 <li>Click the title of the study from which you choose to analyze or
932 download a file or subset.</li>
933 <li>Click the Documentation, Data and Analysis tab for the study.</li>
934 <li>In the list of study files, locate the network data file that you
935 choose to download, subset, or analyze. You can download data sets
936 for a file only if the file entry includes the subset icon.</li>
937 <li>Click the&nbsp;<em>Access Subset/Analysis</em>&nbsp;link associated with the
938 selected file. If prompted, check the&nbsp;<em>I accept</em>&nbsp;box and click
939 Continue to accept the Terms of Use.
940 You see the Data File page listing data for the file that you choose
941 to subset or analyze.</li>
942 </ol>
943 <p><strong>Subset Network Data</strong></p>
944 <p>There are two ways in which you can subset network data. First, you can
945 run a manual query, and build a query of specific values for edge or
946 vertex data with which to subset the data. Or, you can select from among
947 three automatically generated queries with which to subset the data:</p>
948 <ul class="simple">
949 <li>Largest graph - Subset the &lt;nth&gt; largest connected component of the
950 network. That is, the largest group of nodes that can reach one
951 another by walking across edges.</li>
952 <li>Neighborhood - Subset the &lt;nth&gt; neighborhood of the selected
953 vertices. That is, generate a subgraph of the original network
954 composed of all vertices that are positioned at most &lt;n&gt; steps away
955 from the currently selected vertices in the original network, plus
956 all of the edges that connect them.</li>
957 </ul>
958 <p>You also can successively subset data to isolate specific values
959 progressively.</p>
960 <p>Continue to the next topics for detailed information about subsetting a
961 network data set.</p>
962 <p><strong>Subset Manually</strong></p>
963 <p>Perform a manual query to slice a graph based on the attributes of its
964 vertices or edges. You choose whether to subset the graph based on
965 vertices or edges, then use the Manual Query Builder or free-text Query
966 Workspace fields to construct a query based on that element&#8217;s
967 attributes. A single query can pertain only to vertices or only to
968 edges, never both. You can perform separate, sequential vertex or edge
969 queries.</p>
970 <p>When you perform a vertex query, all vertices whose attributes do not
971 satisfy the query are dropped from the graph, in addition to all edges
972 that touch them. When you perform an edge query, all edges whose
973 attributes do not satisfy the criteria are dropped, but all vertices
974 remain <em>unless</em> you enable the <em>Eliminate disconnected vertices</em> check box. Note that enabling this option drops all
975 disconnected vertices whether or not they were disconnected before the
976 edge query.</p>
977 <p>Review the Network Data Tips before you start work with a study&#8217;s files.</p>
978 <p>To subset variables within a network data set by using a manually
979 defined query:</p>
980 <ol class="arabic">
981 <li><p class="first">In the Data File page, click the Manual Query radio button near the
982 top of the page.</p>
983 </li>
984 <li><p class="first">Use the Attribute Set drop-down list and select Vertex to subset by
985 node or vertex values.
986 Select Edge to subset by edge values.</p>
987 </li>
988 <li><p class="first">Build the first attribute selection value in the Manual Query Builder
989 panel:</p>
990 <ol class="arabic simple">
991 <li>Select a value in the Attributes list to assign values on which to
992 subset.</li>
993 <li>Use the Operators drop-down list to choose the function by which
994 to define attributes for selection in this query.</li>
995 <li>In the Values field, type the specific values to use for selection
996 of the attribute.</li>
997 <li>Click <em>Add to Query</em>&nbsp;to complete the attribute definition for
998 selection.
999 You see the query string for this attribute in the Query Workspace
1000 field.</li>
1001 </ol>
1002 <p>Alternatively, you can enter your query directly by typing it into
1003 the Query Workspace field.</p>
1004 </li>
1005 <li><p class="first">Continue to add selection values to your query by using the Manual
1006 Query Builder tools.</p>
1007 </li>
1008 <li><p class="first">To remove any verticies that do not connect with other data in the
1009 set, check the&nbsp;<em>Eliminate disconnected vertices</em>&nbsp;check box.</p>
1010 </li>
1011 <li><p class="first">When you complete construction of your query string, click&nbsp;<em>Run</em>&nbsp;to
1012 perform the query.</p>
1013 </li>
1014 <li><p class="first">Scroll to the bottom of the window, and when the query is processed
1015 you see a new entry in the Subset History panel that defines your
1016 query.</p>
1017 </li>
1018 </ol>
1019 <p>Continue to build a successive subset or download a subset.</p>
1020 <p><strong>Subset Automatically</strong></p>
1021 <p>Peform an Automatic Query to select a subgraph of the nextwork based on
1022 structural properties of the network. Remember to review the Network
1023 Data Tips before you start work with a study&#8217;s files.</p>
1024 <p>To subset variables within a network data set by using an automatically
1025 generated query:</p>
1026 <ol class="arabic simple">
1027 <li>In the Data File page, click the Automatic Query radio button near
1028 the middle of the page.</li>
1029 <li>Use the Function drop-down list and select the type of function with
1030 which to select your subset:<ul>
1031 <li>Largest graph - Subset the &lt;nth&gt; largest group of nodes that can
1032 reach one another by walking across edges.</li>
1033 <li>Neighborhood - Generate a subgraph of the original network
1034 composed of all vertices that are positioned at most &lt;n&gt; steps
1035 away from the currently selected vertices in the original network,
1036 plus all of the edges that connect them. This is the only query
1037 that can (and generally does) increase the number of vertices and
1038 edges selected.</li>
1039 </ul>
1040 </li>
1041 <li>In the Nth field, enter the &lt;nth&gt; degree with which to select data
1042 using that function.</li>
1043 <li>Click&nbsp;<em>Run</em>&nbsp;to perform the query.</li>
1044 <li>Scroll to the bottom of the window, and when the query is processed
1045 you see a new entry in the Subset History panel that defines your
1046 query.</li>
1047 </ol>
1048 <p>Continue to build a successive subset or download a subset.</p>
1049 <p><strong>Build or Restart Subsets</strong></p>
1050 <p><strong>Build a Subset</strong></p>
1051 <p>To build successive subsets and narrow your data selection
1052 progressively:</p>
1053 <ol class="arabic simple">
1054 <li>Perform a manual or automatic subset query on a selected data set.</li>
1055 <li>Perform a second query to further narrow the results of your previous
1056 subset activity.</li>
1057 <li>When you arrive at the subset with which you choose to work, continue
1058 to analyze or download that subset.</li>
1059 </ol>
1060 <p><strong>Undo Previous Subset</strong></p>
1061 <p>You can reset, or undo, the most recent subsetting action for a data
1062 set. Note that you can do this only one time, and only to the most
1063 recent subset.</p>
1064 <p>Scroll to the Subset History panel at the bottom of the page and
1065 click&nbsp;<em>Undo</em>&nbsp;in the last row of the list of successive subsets.
1066 The last subset is removed, and the previous subset is available for
1067 downloading, further subsetting, or analysis.</p>
1068 <p><strong>Restart Subsetting</strong></p>
1069 <p>You can remove all subsetting activity and restore data to the original
1070 set.</p>
1071 <p>Scroll to the Subset History panel at the bottom of the page and
1072 click&nbsp;<em>Restart</em>&nbsp;in the row labeled&nbsp;<em>Initial State</em>.
1073 The data set is restored to the original condition, and is available
1074 for downloading, subsetting, or analysis.</p>
1075 <p><strong>Run Network Measures</strong></p>
1076 <p>When you finish selecting the specific data that you choose to analyze,
1077 run a Network Measure analysis on that data. Review the Network Data
1078 Tips before you start your analysis.</p>
1079 <ol class="arabic simple">
1080 <li>In the Data File page, click the Network Measure radio button near
1081 the bottom of the page.</li>
1082 <li>Use the Attributes drop-down list and select the type of analysis to
1083 perform:<ul>
1084 <li>Page Rank - Determine how much influence comes from a specific
1085 actor or node.</li>
1086 <li>Degree - Determine the number of relationships or collaborations
1087 exist within a network data set.</li>
1088 <li>Unique Degree - Determine the number of collaborators that exist.</li>
1089 <li>In Largest Component - Determine the largest component of a
1090 network.</li>
1091 <li>Bonacich Centrality - Determine the importance of a main actor or
1092 node.</li>
1093 </ul>
1094 </li>
1095 <li>In the Parameters field, enter the specific value with which to
1096 subset data using that function:<ul>
1097 <li>Page Rank - Enter a value for the parameter &lt;d&gt;, a proportion,
1098 between 0 and 1.</li>
1099 <li>Degree - Enter the number of relationships to extract from a
1100 network data set.</li>
1101 <li>Unique Degree - Enter the number of unique relationships to
1102 extract.</li>
1103 <li>In Largest Component - Enter the number of components to extract
1104 from a network data set, starting with the largest.</li>
1105 </ul>
1106 </li>
1107 <li>Click <em>Run</em> to perform the analysis.</li>
1108 <li>Scroll to the bottom of the window, and when the analysis is
1109 processed you see a new entry in the Subset History panel that
1110 contains your analyzed data.</li>
1111 </ol>
1112 <p>Continue to download the analyzed subset.</p>
1113 <p><strong>Download Network Subsets or Measures</strong></p>
1114 <p>When you complete subsetting and analysis of a network data set, you can
1115 download the final set of data. Network data subsets are downloaded in a
1116 zip archive, which has the name <tt class="docutils literal"><span class="pre">subset_&lt;original</span> <span class="pre">file</span> <span class="pre">name&gt;.zip</span></tt>.
1117 This archive contains three files:</p>
1118 <ul class="simple">
1119 <li><tt class="docutils literal"><span class="pre">subset.xml</span></tt> - A GraphML formatted file that contains the final
1120 subsetted or analyzed data.</li>
1121 <li><tt class="docutils literal"><span class="pre">verticies.tab</span></tt> - A tabular file that contains all node data for
1122 the final set.</li>
1123 <li><tt class="docutils literal"><span class="pre">edges.tab</span></tt> - A tabular file that contains all relationship data
1124 for the final set.</li>
1125 </ul>
1126 <p>Note: Each time you download a subset of a specific network data set, a
1127 zip archive is downloaded that has the same name. All three zipped files
1128 within that archive also have the same names. Be careful not to
1129 overwrite a downloaded data set that you choose to keep when you perform
1130 sucessive downloads.</p>
1131 <p>To download a final set of data:</p>
1132 <ol class="arabic simple">
1133 <li>Scroll to the Subset History panel on the Data File page.</li>
1134 <li>Click <em>Download Latest Results</em> at the bottom of the history list.</li>
1135 <li>Follow your browser&#8217;s prompts to open or save the data file to your
1136 computer&#8217;s disk drive. Be sure to save the file in a unique location
1137 to prevent overwritting an existing downloaded data file.</li>
1138 </ol>
1139 <p><strong>Network Data Tips</strong></p>
1140 <p>Use these guidelines when subsetting or analyzing network data:</p>
1141 <ul class="simple">
1142 <li>For a Page rank network measure, the value for the parameter &lt;d&gt; is a
1143 proportion and must be between 0 and 1. Higher values of &lt;d&gt; increase
1144 dispersion, while values of &lt;d&gt; closer to zero produce a more uniform
1145 distribution. PageRank is normalized so that all of the PageRanks sum
1146 to 1.</li>
1147 <li>For a Bonacich Centrality network measure, the alpha parameter is a
1148 proportion that must be between -1 and +1. It is normalized so that
1149 all alpha centralities sum to 1.</li>
1150 <li>For a Bonacich Centrality network measure, the exo parameter must be
1151 greater than 0. A higher value of exo produces a more uniform
1152 distribution of centrality, while a lower value allows more
1153 variation.</li>
1154 <li>For a Bonacich Centrality network measure, the original alpha
1155 parameter of alpha centrality takes values only from -1/lambda to
1156 1/lambda, where lambda is the largest eigenvalue of the adjacency
1157 matrix. In this Dataverse Network implementation, the alpha parameter
1158 is rescaled to be between -1 and 1 and represents the proportion of
1159 1/lambda to be used in the calculation. Thus, entering alpha=1 sets
1160 alpha to be 1/lambda. Entering alpha=0.5 sets alpha to be
1161 1/(2*lambda).</li>
1162 </ul>
1163 </div>
1164 </div>
1165 <div class="section" id="data-visualization">
1166 <h3>Data Visualization<a class="headerlink" href="#data-visualization" title="Permalink to this headline">¶</a></h3>
1167 <p>Data Visualization allows contributors to make time series
1168 visualizations available to end users. These visualizations may be
1169 viewable and downloadable as graphs or data tables.&nbsp;Please see the
1170 appropriate guide for more information on setting up a visualization or
1171 viewing one.</p>
1172 <div class="section" id="explore-data">
1173 <h4>Explore Data<a class="headerlink" href="#explore-data" title="Permalink to this headline">¶</a></h4>
1174 <p>The study owner may make a data visualization interface available to
1175 those who can view a study.&nbsp; This will allow you to select various data
1176 variables and see a time series graph or data table.&nbsp; You will also be
1177 able to download your custom graph for use in your own reports or
1178 articles.</p>
1179 <p>The study owner will at least provide a list of data measures from which
1180 to choose.&nbsp;&nbsp; These measures may be divided into types.&nbsp; If they are you
1181 will be able to narrow the list of measures by first selecting a measure
1182 type.&nbsp; Once you have selected a measure, if there are multiple variables
1183 associated with the measure you will be able to select one or more
1184 filters to uniquely identify a variable. By default any filter assigned
1185 to a variable will become the label associated with the variable in the
1186 graph or table.&nbsp; &nbsp;By pressing the Add Line button you will add the
1187 selected variable to your custom graph.</p>
1188 <p>&nbsp; <img alt="image0" src="_images/measure_selected.png" /></p>
1189 <p>Once you have added data to your graph you will be able to customize it
1190 further.&nbsp; You will be given a choice of display options made available
1191 by the study owner.&nbsp; These may include an interactive flash graph, a
1192 static image graph and a numerical data table.&nbsp;&nbsp; You will also be
1193 allowed to edit the graph title, which by default is the name of the
1194 measure or measures selected. You may also edit the Source Label.
1195 Other customizable features are the height and the legend location of
1196 the image graph.&nbsp; You may also select a subset of the data by selecting
1197 the start and end points of the time series.&nbsp; Finally, on the display
1198 tab you may opt to display the series as indices in which case a single
1199 data point known as the reference period will be designated as 100 and
1200 all other points of the series will be calculated relative to the
1201 reference period.&nbsp; If you select data points that do not have units in
1202 common (i.e. one is in percent while the other is in dollars) then the
1203 display will automatically be set to indices with the earliest common
1204 data point as the default reference period.</p>
1205 <p><img alt="image1" src="_images/complex_graph_screenshot.png" /></p>
1206 <p>On the Line Details tab you will see additional information on the data
1207 you have selected.&nbsp; This may include links to outside web pages that
1208 further explain the data.&nbsp; On this tab you will also be able to edit the
1209 label or delete the line from your custom graph.</p>
1210 <p>On the Export tab you will be given the opportunity to export your
1211 custom graph and/or data table.&nbsp;&nbsp; If you select multiple files for
1212 download they will be bound together in a single zip file.</p>
1213 <p>The Refresh button clears any data that you have added to your custom
1214 graph and resets all of the display options to their default values.</p>
1215 </div>
1216 <div class="section" id="set-up">
1217 <h4>Set Up<a class="headerlink" href="#set-up" title="Permalink to this headline">¶</a></h4>
1218 <p>This feature allows you to make time series visualizations available to
1219 your end users.&nbsp;&nbsp; These visualizations may be viewable and downloadable
1220 as graphs or data tables.&nbsp; In the current beta version of the feature
1221 your data file must be subsettable and must contain at least one date
1222 field and one or more measures.&nbsp; You will be able to associate data
1223 fields from your file to a time variable and multiple measures and
1224 filters.</p>
1225 <p>When you select Set Up Exploration from within a study, you must first
1226 select the file for which you would like to set up the exploration.&nbsp; The
1227 list of files will include all subsettable data files within the study.</p>
1228 <p>Once you have selected a file you will go to a screen that has 5 tabs to
1229 guide you through the data visualization set-up. (In general, changes
1230 made to a visualization on the individual tabs are not saved to the
1231 database until the form’s Save button is pressed.&nbsp; When you are in add
1232 or edit mode on a tab, the tab will have an update or cancel button to
1233 update the “working copy” of a visualization or cancel the current
1234 update.)</p>
1235 <p>If you have a previously set up an exploration for a data file you may copy that exploration to a new file.
1236 When you select a file for set up you will be asked if you want to copy an exploration from another data file
1237 and will be presented a list of files from which to choose. Please note that the data variable names must
1238 be identical in both files for this migration to work properly.</p>
1239 <p><strong>Time Variable</strong></p>
1240 <p>On the first tab you select the time variable of your data file.&nbsp; The
1241 variable list will only include those variables that are date or time
1242 variables. &nbsp;These variables must contain a date in each row.&nbsp;&nbsp;You may
1243 also enter a label in the box labeled Units.&nbsp; This label will be
1244 displayed under the x-axis of the graph created by the end user.</p>
1245 <p><img alt="image2" src="_images/edittimevariablescreenshot.png" /></p>
1246 <p><strong>Measures</strong></p>
1247 <p>On the Measures tab you may assign measures to the variables in your
1248 data file.&nbsp; First you may customize the label that the end user will see
1249 for measures.&nbsp; Next you may add measures by clicking the “Add Measure”
1250 link.&nbsp; Once you click that link you must give your measure a unique
1251 name.&nbsp; Then you may assign Units to it.&nbsp; Units will be displayed as the
1252 y-axis label of any graph produced containing that measure.&nbsp; In order to
1253 assist in the organizing of the measures you may create measure types
1254 and assign your measures to one or more measure types.&nbsp; Finally, the
1255 list of variables for measures will include all those variables that are
1256 entered as numeric in your data file.&nbsp; If you assign multiple variables
1257 to the same measure you will have to distinguish between them by
1258 assigning appropriate filters.&nbsp;&nbsp; For the end user, the measure will be
1259 the default graph name.</p>
1260 <p><img alt="image3" src="_images/editmeasuresscreenshot.png" /></p>
1261 <p><strong>Filters</strong></p>
1262 <p>On the filters tab you may assign filters to the variables in your data
1263 file.&nbsp; Generally filters contain demographic, geographic or other
1264 identifying information about the variables.&nbsp; For a given group of
1265 filters only one filter may be assigned to a single variable.&nbsp; The
1266 filters assigned to a variable must be sufficient to distinguish among
1267 the variables assigned to a single measure.&nbsp;&nbsp; Similar to measures,
1268 filters may be assigned to one or more types.&nbsp;&nbsp; For the end user the
1269 filter name will be the default label of the line of data added to a
1270 graph.</p>
1271 <p><img alt="image4" src="_images/editfiltersscreenshot.png" /></p>
1272 <div class="line-block">
1273 <div class="line"><br /></div>
1274 </div>
1275 <p><strong>Sources</strong></p>
1276 <p>On the Sources tab you can indicate the source of each of the variables
1277 in your data file.&nbsp; By default, the source will be displayed as a note
1278 below the x-axis labels.&nbsp; You may assign a single source to any or all
1279 of your data variables. &nbsp;You may also assign multiple sources to any of
1280 your data variables.</p>
1281 <p><img alt="image5" src="_images/sourcetabscreenshot.png" /></p>
1282 <div class="line-block">
1283 <div class="line"><br /></div>
1284 </div>
1285 <p><strong>Display</strong></p>
1286 <p>On the Display tab you may customize what the end user sees in the Data
1287 Visualization interface.&nbsp; Options include the data visualization formats
1288 made available to the end user and default view, the Measure Type label,
1289 and the Variable Info Label.</p>
1290 <div class="line-block">
1291 <div class="line"><br /></div>
1292 <div class="line-block">
1293 <div class="line"><img alt="image6" src="_images/displaytabscreenshot.png" /></div>
1294 </div>
1295 </div>
1296 <p><strong>Validate Button</strong></p>
1297 <p>When you press the “Validate” button the current state of your
1298 visualization data will be validated.&nbsp; In order to pass validation your
1299 data must have one time variable defined.&nbsp; There must also be at least
1300 one measure variable assigned.&nbsp; If more than one variable is assigned to
1301 a given measure then filters must be assigned such that each single
1302 variable is defined by the measure and one or more filters.&nbsp; If the data
1303 visualization does not pass validation a detailed error message
1304 enumerating the errors will be displayed.</p>
1305 <p><strong>Release Button</strong></p>
1306 <p>Once the data visualization has been validated you may release it to end
1307 users by pressing the “Release” button.&nbsp; The release button will also
1308 perform a validation.&nbsp; Invalid visualizations will not be released, but
1309 a detailed error message will not be produced.</p>
1310 <p><strong>Save Button</strong></p>
1311 <p>The “Save” button will save any changes made to a visualization on the
1312 tabs to the database.&nbsp;&nbsp; If a visualization has been released and changes
1313 are saved that would make it invalid the visualization will be set to
1314 “Unreleased”.</p>
1315 <p><strong>Exit Button</strong></p>
1316 <p>To exit the form press the “Exit” button.&nbsp; You will be warned if you
1317 have made any unsaved changes.</p>
1318 <p><strong>Examples</strong></p>
1319 <p>Simplest case – a single measure associated with a single variable.</p>
1320 <p>Data variable contains information on average family income for all
1321 Americans.&nbsp; The end user of the visualization will see an interface as
1322 below:</p>
1323 <p><img alt="image7" src="_images/simple_explore_data.png" /></p>
1324 <p>Complex case - multiple measures and types along with multiple filters
1325 and filter types.&nbsp; If you have measures related to both income and
1326 poverty rates you can set them up as measure types and associate the
1327 appropriate measures with each type.&nbsp; Then, if you have variables
1328 associated with multiple demographic groups you can set them up as
1329 filters.&nbsp; You can set up filter types such as age, gender, race and
1330 state of residence.&nbsp; Some of your filters may belong to multiple types
1331 such as males age 18-34.</p>
1332 <p><img alt="image8" src="_images/complex_exploration.png" /></p>
1333 </div>
1334 </div>
1335 </div>
1336 <div class="section" id="dataverse-administration">
1337 <h2>Dataverse Administration<a class="headerlink" href="#dataverse-administration" title="Permalink to this headline">¶</a></h2>
1338 <p>Once a user creates a dataverse becomes its owner and therefore is the
1339 administrator of that dataverse. The dataverse administrator has access
1340 to manage the settings described in this guide.</p>
1341 <div class="section" id="create-a-dataverse">
1342 <h3>Create a Dataverse<a class="headerlink" href="#create-a-dataverse" title="Permalink to this headline">¶</a></h3>
1343 <p>A dataverse is a container for studies and is the home for an individual
1344 scholar&#8217;s or organization&#8217;s data.</p>
1345 <p>Creating a dataverse is easy but first you must be a registered user.
1346 Depending on site policy, there may be a&nbsp;&#8220;Create a Dataverse&#8221; link on
1347 the Network home page. This first walks you through creating an account,
1348 then a dataverse.</p>
1349 <ol class="arabic simple">
1350 <li>Fill in the required information:</li>
1351 </ol>
1352 <blockquote>
1353 <div><ul class="simple">
1354 <li><strong>Type of Dataverse</strong>: Choose Scholar if it represents an individual&#8217;s work otherwise choose Basic.</li>
1355 <li><strong>Dataverse Name</strong>: This will be displayed on the network and dataverse home pages. If this is a Scholar dataverse it will automatically be filled in with the scholar&#8217;s first and last name.</li>
1356 <li><strong>Dataverse Alias</strong>: This is an abbreviation, usually lower-case, that becomes part of the URL for the new dataverse.</li>
1357 </ul>
1358 <blockquote>
1359 <div>The required fields to create a dataverse are configurable in the Network Options, so fields that are required may also include
1360 Affiliation, Network Home Page Description, and Classification.</div></blockquote>
1361 </div></blockquote>
1362 <ol class="arabic simple" start="2">
1363 <li>Click &#8220;Save&#8221; and you&#8217;re done! An email will be sent to you with more information, including the URL to access you new dataverse.</li>
1364 </ol>
1365 <p>*Required information can vary depending on site policy. Required fields are noted with a <strong>red asterisk</strong>.</p>
1366 </div>
1367 <div class="section" id="edit-general-settings">
1368 <h3>Edit General Settings<a class="headerlink" href="#edit-general-settings" title="Permalink to this headline">¶</a></h3>
1369 <p>Use the General Settings tab on the Options page to release your
1370 dataverse, change the name, alias, and classification of your
1371 dataverse.&nbsp;The classifications are used to browse to your dataverse from
1372 the Network home page.</p>
1373 <p>Navigate to the&nbsp;General Settings from the Options page:</p>
1374 <p>Dataverse home page &gt; Options page &gt; Settings tab &gt; General subtab</p>
1375 <p>To edit release your dataverse:</p>
1376 <p>Select <em>Released</em> from the drop-down list when your dataverse is ready
1377 to go public. Select <em>Not Released</em> if you wish to block public access
1378 to your dataverse.</p>
1379 <p>Your dataverse cannot be released if it does not contain any released
1380 studies. Create a study or define a collection with studies from other
1381 dataverses before you attempt to make your dataverse public.</p>
1382 <p>To edit the affiliation, name, or alias settings of your dataverse:</p>
1383 <p>If you edit a Scholar dataverse type, you can edit the following fields:</p>
1384 <ul class="simple">
1385 <li>First Name - Edit your first name, which appears with your last name
1386 on the Network home page in the Scholar Dataverse group.</li>
1387 <li>Last Name - Edit your last name, which appears with your first name
1388 on the Network home page in the Scholar Dataverse group.</li>
1389 </ul>
1390 <p>If you edit either Scholar or basic types, you can edit any of the
1391 following fields:</p>
1392 <ul class="simple">
1393 <li>Affiliation - Edit your institutional identity.</li>
1394 <li>Dataverse Name - Edit the title for your dataverse, which appears on
1395 your dataverse home page. There are no naming restrictions.</li>
1396 <li>Dataverse Alias - Edit your dataverse&#8217;s URL.&nbsp;Special characters
1397 (~,`, !, &#64;, #, $, %, ^, &amp;, and *) and spaces are not allowed.
1398 <strong>Note</strong>: if you change the Dataverse Alias field, the URL for your
1399 Dataverse changes (http//.../dv/&#8217;alias&#8217;), which affects links to this
1400 page.</li>
1401 <li>Network Home Page Description - Edit the text that appears beside the
1402 name of your dataverse on the Network home page.</li>
1403 <li>Classification - Check the classifications, or groups, in which you
1404 choose to include your dataverse. Remove the check for any
1405 classifications that you choose not to join.</li>
1406 </ul>
1407 </div>
1408 <div class="section" id="edit-layout-branding">
1409 <span id="id4"></span><h3>Edit Layout Branding<a class="headerlink" href="#edit-layout-branding" title="Permalink to this headline">¶</a></h3>
1410 <p><strong>Customize Layout Branding (header/footer) to match your website</strong></p>
1411 <p>The Layout Branding allows you to customize your dataverse, by
1412 <strong>adding HTML to the default banner and footer</strong>, such as that used on
1413 your personal website. If your website has such layout elements as a
1414 navigation menu or images, you can add them here. Each dataverse is
1415 created with a default customization added, which you can leave as is,
1416 edit to change the background color, or add your own customization.</p>
1417 <p>Navigate to the&nbsp;Layout Branding from the Options page:</p>
1418 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Customization</span> <span class="pre">subtab</span></tt></p>
1419 <p>To edit the banner and footer of your dataverse:</p>
1420 <ol class="arabic simple">
1421 <li>In the Custom Banner field, enter your plain text, and HTML to define
1422 your custom banner.</li>
1423 <li>In the Custom Footer field, enter your plain text, and HTML to define
1424 your custom footer.</li>
1425 </ol>
1426 <p><strong>Embed your Dataverse into your website (iframes)</strong></p>
1427 <p>Want to embed your Dataverse on an OpenScholar site? Follow <a class="reference internal" href="#openscholar"><em>these special instructions</em></a>.</p>
1428 <p>For dataverse admins that are more advanced HTML developers, or that
1429 have HTML developers available to assist them, you can create a page on
1430 your site and add the dataverse with an iframe.</p>
1431 <ol class="arabic simple">
1432 <li>Create a new page, that you will host on your site.</li>
1433 <li>Add the following HTML code to the content area of that new
1434 page.</li>
1435 </ol>
1436 <blockquote>
1437 <div><div class="line-block">
1438 <div class="line"><tt class="docutils literal"><span class="pre">&lt;script</span> <span class="pre">type=&quot;text/javascript&quot;&gt;</span></tt></div>
1439 <div class="line"><tt class="docutils literal"><span class="pre">var</span> <span class="pre">dvn_url</span> <span class="pre">=</span> <span class="pre">&quot;[SAMPLE_ONLY_http://dvn.iq.harvard.edu/dvn/dv/sampleURL]&quot;;</span></tt></div>
1440 <div class="line"><tt class="docutils literal"><span class="pre">var</span> <span class="pre">regexS</span> <span class="pre">=</span> <span class="pre">&quot;[\\?&amp;]dvn_subpage=([^&amp;#]*)&quot;;</span></tt></div>
1441 <div class="line"><tt class="docutils literal"><span class="pre">var</span> <span class="pre">regex</span> <span class="pre">=</span> <span class="pre">new</span> <span class="pre">RegExp(</span> <span class="pre">regexS</span> <span class="pre">);</span></tt></div>
1442 <div class="line"><tt class="docutils literal"><span class="pre">var</span> <span class="pre">results</span> <span class="pre">=</span> <span class="pre">regex.exec(</span> <span class="pre">window.location.href</span> <span class="pre">);</span></tt></div>
1443 <div class="line"><tt class="docutils literal"><span class="pre">if(</span> <span class="pre">results</span> <span class="pre">!=</span> <span class="pre">null</span> <span class="pre">)</span> <span class="pre">dvn_url</span> <span class="pre">=</span> <span class="pre">dvn_url</span> <span class="pre">+</span> <span class="pre">results[1];document.write('&lt;iframe</span> <span class="pre">src=&quot;'</span> <span class="pre">+</span> <span class="pre">dvn_url</span> <span class="pre">+</span> <span class="pre">'&quot;</span></tt></div>
1444 <div class="line"><tt class="docutils literal"><span class="pre">onLoad=&quot;set_dvn_url(this)&quot;</span> <span class="pre">width=&quot;100%&quot;</span> <span class="pre">height=&quot;600px&quot;</span> <span class="pre">frameborder=&quot;0&quot;</span></tt></div>
1445 <div class="line"><tt class="docutils literal"><span class="pre">style=&quot;background-color:#FFFFFF;&quot;&gt;&lt;/iframe&gt;');</span></tt></div>
1446 <div class="line"><tt class="docutils literal"><span class="pre">&lt;/script&gt;</span></tt></div>
1447 </div>
1448 </div></blockquote>
1449 <ol class="arabic simple" start="3">
1450 <li>Edit that code by adding the URL of your dataverse (replace the
1451 SAMPLE_ONLY URL in the example, including the brackets “[ ]”), and
1452 adjusting the height.&nbsp; We suggest you keep the height at or under
1453 600px in order to fit the iframe into browser windows on computer
1454 monitor of all sizes, with various screen resolutions.</li>
1455 <li>The dataverse is set to have a min-width of 724px, so try give the
1456 page a width closer to 800px.</li>
1457 <li>Once you have the page created on your site, with the iframe code, go
1458 to the Setting tab, then the Customization subtab on your dataverse
1459 Options page, and click the checkbox that disables customization for
1460 your dataverse.</li>
1461 <li>Then enter the URL of the new page on your site. That will redirect
1462 all users to the new page on your site.</li>
1463 </ol>
1464 <p><strong>Layout Branding Tips</strong></p>
1465 <ul class="simple">
1466 <li>HTML markup, including <tt class="docutils literal"><span class="pre">script</span></tt> tags for JavaScript, and <tt class="docutils literal"><span class="pre">style</span></tt>
1467 tags for an internal style sheet, are permitted. The <tt class="docutils literal"><span class="pre">html,</span></tt>
1468 <tt class="docutils literal"><span class="pre">head</span></tt> and <tt class="docutils literal"><span class="pre">body</span></tt> element tags are not allowed.</li>
1469 <li>When you use an internal style sheet to insert CSS into your
1470 customization, it is important to avoid using universal (&#8220;<tt class="docutils literal"><span class="pre">*</span></tt>&#8221;)
1471 and type (&#8220;<tt class="docutils literal"><span class="pre">h1</span></tt>&#8221;) selectors, because these can overwrite the
1472 external style sheets that the dataverse is using, which can break
1473 the layout, navigation or functionality in the app.</li>
1474 <li>When you link to files, such as images or pages on a web server
1475 outside the network, be sure to use the full URL (e.g.
1476 <tt class="docutils literal"><span class="pre">http://www.mypage.com/images/image.jpg</span></tt>).</li>
1477 <li>If you recreate content from a website that uses frames to combine
1478 content on the sides, top, or bottom, then you must substitute the
1479 frames with <tt class="docutils literal"><span class="pre">table</span></tt> or <tt class="docutils literal"><span class="pre">div</span></tt> element types. You can open such an
1480 element in the banner field and close it in the footer field.</li>
1481 <li>Each time you click &#8220;Save&#8221;, your banner and footer automatically are
1482 validated for HTML and other code errors. If an error message is
1483 displayed, correct the error and then click &#8220;Save&#8221; again.</li>
1484 <li>You can use the banner or footer to house a link from your homepage
1485 to your personal website. Be sure to wait until you release your
1486 dataverse to the public before you add any links to another website.
1487 And, be sure to link back from your website to your homepage.</li>
1488 <li>If you are using an OpenScholar or iframe site and the redirect is
1489 not working, you can edit your branding settings by adding a flag to
1490 your dataverse URL: disableCustomization=true. For example:
1491 <tt class="docutils literal"><span class="pre">dvn.iq.harvard.edu/dvn/dv/mydv?disableCustomization=true</span></tt>. To
1492 reenable: <tt class="docutils literal"><span class="pre">dvn.iq.harvard.edu/dvn/dv/mydv?disableCustomization=false</span></tt>.
1493 Disabling the customization lasts for the length of the user session.</li>
1494 </ul>
1495 </div>
1496 <div class="section" id="edit-description">
1497 <h3>Edit Description<a class="headerlink" href="#edit-description" title="Permalink to this headline">¶</a></h3>
1498 <p>The Description is displayed on your dataverse Home page.&nbsp;Utilize this
1499 field to display announcements or messaging.</p>
1500 <p>Navigate to the Description from the Options page:</p>
1501 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">General</span> <span class="pre">subtab</span> <span class="pre">&gt;Home</span> <span class="pre">Page</span> <span class="pre">Description</span></tt></p>
1502 <p>To change the content of this description:</p>
1503 <ul class="simple">
1504 <li>Enter your description or announcement text in the field provided.
1505 Note: A light blue background in any form field indicates HTML, JavaScript, and style tags are permitted. The <tt class="docutils literal"><span class="pre">html,</span></tt>, <tt class="docutils literal"><span class="pre">head</span></tt> and <tt class="docutils literal"><span class="pre">body</span></tt> element types are not allowed.</li>
1506 </ul>
1507 <p>Previous to the Version 3.0 release of the Dataverse Network, the
1508 Description had a character limit set at 1000, which would truncate
1509 longer description with a <strong>more &gt;&gt;</strong> link. This functionality has been
1510 removed, so that you can add as much text or code to that field as you
1511 wish. If you would like to add the character limit and truncate
1512 functionality back to your dataverse, just add this snippet of
1513 Javascript to the end of your description.</p>
1514 <blockquote>
1515 <div><div class="line-block">
1516 <div class="line"><tt class="docutils literal"><span class="pre">&lt;script</span> <span class="pre">type=&quot;text/javascript&quot;&gt;</span></tt></div>
1517 <div class="line">&nbsp;&nbsp;&nbsp; <tt class="docutils literal"><span class="pre">jQuery(document).ready(function(){</span></tt></div>
1518 <div class="line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <tt class="docutils literal"><span class="pre">jQuery(&quot;.dvn\_hmpgMainMessage</span> <span class="pre">span&quot;).truncate({max\_length:1000});</span></tt></div>
1519 <div class="line">&nbsp;&nbsp;&nbsp; <tt class="docutils literal"><span class="pre">});</span></tt></div>
1520 <div class="line"><tt class="docutils literal"><span class="pre">&lt;/script&gt;</span></tt></div>
1521 </div>
1522 </div></blockquote>
1523 </div>
1524 <div class="section" id="edit-study-comments-settings">
1525 <span id="id5"></span><h3>Edit Study Comments Settings<a class="headerlink" href="#edit-study-comments-settings" title="Permalink to this headline">¶</a></h3>
1526 <p>You can enable or disable the Study User Comments feature in your
1527 dataverse. If you enable Study User Comments, any user has the option to
1528 add a comment to a study in this dataverse. By default, this feature is
1529 enabled in all new dataverses. Note that you should ensure there are
1530 terms of use at the network or dataverse level that define acceptable
1531 use of this feature if it is enabled.</p>
1532 <p>Navigate to the Study User Comments from the Options page:</p>
1533 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">General</span> <span class="pre">subtab</span> <span class="pre">&gt;Allow</span> <span class="pre">Study</span> <span class="pre">Comments</span></tt></p>
1534 <p>A user must create an account in your dataverse to use the comment
1535 feature. When you enable this feature, be aware that new accounts will
1536 be created in your dataverse when users add comments to studies. In
1537 addition, the Report Abuse function in the comment feature is managed by
1538 the network admin. If a user reads a comment that might be
1539 inappropriate, that user can log in or register an account and access
1540 the Report Abuse option. Comments are reported as abuse to the network
1541 admin.</p>
1542 <p>To manage the Study User Comments feature in your dataverse:</p>
1543 <ul class="simple">
1544 <li>Click the &#8220;Allow Study Comments&#8221; check box to enable comments.</li>
1545 <li>Click the checked box to remove the check and disable comments.</li>
1546 </ul>
1547 </div>
1548 <div class="section" id="manage-e-mail-notifications">
1549 <h3>Manage E-Mail Notifications<a class="headerlink" href="#manage-e-mail-notifications" title="Permalink to this headline">¶</a></h3>
1550 <p>You can edit the e-mail address used on your dataverse’s Contact Us page
1551 and by the network when sending notifications on processes and errors.
1552 By default, the e-mail address used is from the user account of the
1553 dataverse creator.</p>
1554 <p>Navigate to the&nbsp;E-Mail Notifications from the Options page:</p>
1555 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">General</span> <span class="pre">subtab</span> <span class="pre">&gt;E-Mail</span> <span class="pre">Address(es)</span></tt></p>
1556 <p>To edit the contact and notification e-mail address for your dataverse:</p>
1557 <ul class="simple">
1558 <li>Enter one or more e-mail addresses in the <strong>E-Mail Address</strong> field.
1559 Provide the addresses of users who you choose to receive notification
1560 when contacted from this dataverse. Any time a user submits a request
1561 through your dataverse, including the Request to Contribute link and
1562 the Contact Us page, e-mail is sent to all addresses that you enter
1563 in this field. Separate each address from others with a comma. Do not
1564 add any spaces between addresses.</li>
1565 </ul>
1566 </div>
1567 <div class="section" id="add-fields-to-search-results">
1568 <h3>Add Fields to Search Results<a class="headerlink" href="#add-fields-to-search-results" title="Permalink to this headline">¶</a></h3>
1569 <p>Your dataverse includes the network&#8217;s search and browse features to
1570 assist your visitors in locating the data that they need. By default,
1571 the Cataloging Information fields that appear in the search results or
1572 in studies&#8217; listings include the following: study title, authors, ID,
1573 production date, and abstract. You can customize other Cataloging
1574 Information fields to appear in search result listings after the default
1575 fields. Additional fields appear only if they are populated for the
1576 study.</p>
1577 <p>Navigate to the&nbsp;Search Results Fields from the Options page:</p>
1578 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Customization</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Search</span> <span class="pre">Results</span> <span class="pre">Fields</span></tt></p>
1579 <p>To add more Cataloging Information fields listed in the Search or Browse
1580 panels:</p>
1581 <ul class="simple">
1582 <li>Click the check box beside any of the following Cataloging
1583 Information fields to include them in your results pages: Production
1584 Date, Producer, Distribution Date, Distributor, Replication For,
1585 Related Publications, Related Material, and Related Studies.</li>
1586 </ul>
1587 <p>Note: These settings apply to your dataverse only.</p>
1588 </div>
1589 <div class="section" id="set-default-study-listing-sort-order">
1590 <h3>Set Default Study Listing Sort Order<a class="headerlink" href="#set-default-study-listing-sort-order" title="Permalink to this headline">¶</a></h3>
1591 <p>Use the drop-down menu to set the default sort order of studies on the
1592 Study Listing page. By default, they are sorted by Global ID, but you
1593 can also sort by Title, Last Released, Production Date, or Download
1594 Count.</p>
1595 <p>Navigate to the&nbsp;Default Study Listing Sort Order from the Options page:</p>
1596 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Customization</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Default</span> <span class="pre">Sort</span> <span class="pre">Order</span></tt></p>
1597 </div>
1598 <div class="section" id="enable-twitter">
1599 <h3>Enable Twitter<a class="headerlink" href="#enable-twitter" title="Permalink to this headline">¶</a></h3>
1600 <p>If your Dataverse Network has been configured for Automatic Tweeting,
1601 you will see an option listed as &#8220;Enable Twitter.&#8221; When you click this,
1602 you will be redirected to Twtter to authorize the Dataverse Network
1603 application to send tweets for you.</p>
1604 <p>Once authorized, tweets will be sent for each new study or study version
1605 that is released.</p>
1606 <p>To disable Automatic Tweeting, go to the Options page, and click
1607 &#8220;Disable Twitter.&#8221;</p>
1608 <p>Navigate to Enable Twitter from the Options page:</p>
1609 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;&nbsp;Promote</span> <span class="pre">Your</span> <span class="pre">Dataverse</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Sync</span> <span class="pre">Dataverse</span> <span class="pre">With</span> <span class="pre">Twitter</span></tt></p>
1610 </div>
1611 <div class="section" id="get-code-for-dataverse-link-or-search-box">
1612 <h3>Get Code for Dataverse Link or Search Box<a class="headerlink" href="#get-code-for-dataverse-link-or-search-box" title="Permalink to this headline">¶</a></h3>
1613 <p>Add a dataverse promotional link or dataverse search box on your
1614 personal website by copying the code for one of the sample links on this
1615 page, and then pasting it anywhere on your website to create the link.</p>
1616 <p>Navigate to the Code for Dataverse Link or Search Box from the Options
1617 page:</p>
1618 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Promote</span> <span class="pre">Your</span> <span class="pre">Dataverse</span> <span class="pre">subtab</span></tt></p>
1619 </div>
1620 <div class="section" id="edit-terms-for-study-creation">
1621 <h3>Edit Terms for Study Creation<a class="headerlink" href="#edit-terms-for-study-creation" title="Permalink to this headline">¶</a></h3>
1622 <p>You can set up Terms of Use for the dataverse that require users to
1623 acknowledge your terms and click &#8220;Accept&#8221; before they can contribute to
1624 the dataverse.</p>
1625 <p>Navigate to the&nbsp;Terms for Study Creation from the Options page:</p>
1626 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Terms</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Deposit</span> <span class="pre">Terms</span> <span class="pre">of</span> <span class="pre">Use</span></tt></p>
1627 <p>To set Terms of Use for creating or uploading to the dataverse:</p>
1628 <ol class="arabic simple">
1629 <li>Click the Enable Terms of Use check box.</li>
1630 <li>Enter a description of your terms to which visitors must agree before
1631 they can create a study or upload a file to an existing study.
1632 Note: A light blue background in any form field indicates HTML,
1633 JavaScript, and style tags are permitted. The <tt class="docutils literal"><span class="pre">html</span></tt> and <tt class="docutils literal"><span class="pre">body</span></tt>
1634 element types are not allowed.</li>
1635 </ol>
1636 </div>
1637 <div class="section" id="edit-terms-for-file-download">
1638 <h3>Edit Terms for File Download<a class="headerlink" href="#edit-terms-for-file-download" title="Permalink to this headline">¶</a></h3>
1639 <p>You can set up Terms of Use for the network that require users to
1640 acknowledge your terms and click &#8220;Accept&#8221; before they can download or
1641 subset contents from the network.</p>
1642 <p>Navigate to the Terms for File Download from the Options page:</p>
1643 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;&nbsp;Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Terms</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Download</span> <span class="pre">Terms</span> <span class="pre">of</span> <span class="pre">Use</span></tt></p>
1644 <p>To set Terms of Use for downloading or subsetting contents from any
1645 dataverse in the network:</p>
1646 <ol class="arabic simple">
1647 <li>Click the Enable Terms of Use check box.</li>
1648 <li>Enter a description of your terms to which visitors must agree before
1649 they can download or analyze any file.
1650 Note: A light blue background in any form field indicates HTML,
1651 JavaScript, and style tags are permitted. The <tt class="docutils literal"><span class="pre">html</span></tt> and <tt class="docutils literal"><span class="pre">body</span></tt>
1652 element types are not allowed.</li>
1653 </ol>
1654 </div>
1655 <div class="section" id="manage-permissions">
1656 <h3>Manage Permissions<a class="headerlink" href="#manage-permissions" title="Permalink to this headline">¶</a></h3>
1657 <p>Enable contribution invitation, grant permissions to users and groups,
1658 and manage dataverse file permissions.</p>
1659 <p>Navigate to Manage Permissions from the Options page:</p>
1660 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">subtab</span></tt></p>
1661 <p><strong>Contribution Settings</strong></p>
1662 <p>Choose the access level contributors have to your dataverse. Whether
1663 they are allowed to edit only their own studies, all studies, or whether
1664 all registered users can edit their own studies (Open dataverse) or all
1665 studies (Wiki dataverse). In an Open dataverse, users can add studies by
1666 simply creating an account, and can edit their own studies any time,
1667 even after the study is released. In a Wiki dataverse, users cannot only
1668 add studies by creating an account, but also edit any study in that
1669 dataverse. Contributors cannot, however, release a study directly. After
1670 their edits, they submit it for review and a dataverse administrator or
1671 curator will release it.</p>
1672 <p><strong>User Permission Settings</strong></p>
1673 <p>There are several roles defined for users of a Dataverse Network
1674 installation:</p>
1675 <ul class="simple">
1676 <li>Data Users - Download and analyze all types of data</li>
1677 <li>Contributors - Distribute data and receive recognition and citations
1678 to it</li>
1679 <li>Curators - Summarize related data, organize data, or manage multiple
1680 sets of data</li>
1681 <li>Administrators - Set up and manage contributions to your dataverse,
1682 manage the appearance of your dataverse, organize your dataverse
1683 collections</li>
1684 </ul>
1685 <p><strong>Privileged Groups</strong></p>
1686 <p>Enter group name to allow a group access to the dataverse. Groups are
1687 created by network administrators.</p>
1688 <p><strong>Dataverse File Permission Settings</strong></p>
1689 <p>Choose &#8216;Yes&#8217; to restrict ALL files in this dataverse. To restrict files
1690 individually, go to the Study Permissions page of the study containing
1691 the file.</p>
1692 </div>
1693 <div class="section" id="create-user-account">
1694 <h3>Create User Account<a class="headerlink" href="#create-user-account" title="Permalink to this headline">¶</a></h3>
1695 <p>As a registered user, you can:</p>
1696 <ul class="simple">
1697 <li>Add studies to open and wiki dataverses, if available</li>
1698 <li>Contribute to existing studies in wiki dataverses, if available</li>
1699 <li>Add user comments to studies that have this option</li>
1700 <li>Create your own dataverse</li>
1701 </ul>
1702 <p><strong>Network Admin Level</strong></p>
1703 <p>Navigate to Create User Account from the Options page:</p>
1704 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Users</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Create</span> <span class="pre">User</span> <span class="pre">link</span></tt></p>
1705 <p>To create an account for a new user in your Network:</p>
1706 <ol class="arabic">
1707 <li><dl class="first docutils">
1708 <dt>Complete the account information page.</dt>
1709 <dd><p class="first last">Enter values in all required fields. Note: an email address can also be used as a username</p>
1710 </dd>
1711 </dl>
1712 </li>
1713 <li><p class="first">Click Create Account to save your entries.</p>
1714 </li>
1715 <li><p class="first">Go to the Permissions tab on the Options page to give the user
1716 Contributor, Curator or Admin access to your dataverse.</p>
1717 </li>
1718 </ol>
1719 <p><strong>Dataverse Admin Level</strong></p>
1720 <p>Navigate to Create User Account from the Options page:</p>
1721 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;&nbsp;Permissions</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Create</span> <span class="pre">User</span> <span class="pre">link</span></tt></p>
1722 <p>To create an account for a new user in your Dataverse:</p>
1723 <ol class="arabic">
1724 <li><dl class="first docutils">
1725 <dt>Complete the account information page.</dt>
1726 <dd><p class="first last">Enter values in all required fields. Note: an email address can also be used as a username</p>
1727 </dd>
1728 </dl>
1729 </li>
1730 <li><p class="first">Click Create Account to save your entries.</p>
1731 </li>
1732 <li><p class="first">Go to the Permissions tab on the Options page to give the user
1733 Contributor, Curator or Admin access to your dataverse.</p>
1734 </li>
1735 </ol>
1736 <p><strong>New User: Network Homepage</strong></p>
1737 <p>As a new user, to create an account at the <strong>Dataverse Network homepage</strong>, select &#8220;Create Account&#8221;
1738 at the top-right hand side of the page.</p>
1739 <p>Complete the required information denoted by the red asterisk and save.</p>
1740 <p><strong>New User: Dataverse Level</strong></p>
1741 <p>As a new user, to create an account at the <strong>Dataverse level</strong>, select &#8220;Create Account&#8221;
1742 at the top-right hand side of the page. Note: For Open Dataverses select &#8220;Create Account&#8221; in the orange box
1743 on the top right hand side of the page labelled: &#8220;OPEN DATAVERSE&#8221;.</p>
1744 <p>Complete the required information denoted by the red asterisk and save.</p>
1745 </div>
1746 <div class="section" id="download-tracking-data">
1747 <h3>Download Tracking Data<a class="headerlink" href="#download-tracking-data" title="Permalink to this headline">¶</a></h3>
1748 <p>You can view any guestbook responses that have been made in your
1749 dataverse. Beginning with version 3.2 of Dataverse Network, if the
1750 guestbook is not enabled, data will be collected silently based on the
1751 logged-in user or anonymously. The data displayed includes user account
1752 data or the session ID of an anonymous user, the global ID, study title
1753 and file name of the file downloaded, the time of the download, the type
1754 of download and any custom questions that have been answered. The
1755 username/session ID and download type were not collected in the 3.1
1756 version of Dataverse Network. A comma separated values file of all
1757 download tracking data may be downloaded by clicking the Export Results
1758 button.</p>
1759 <p>Navigate to the&nbsp;Download Tracking Data from the Options page:</p>
1760 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Download</span> <span class="pre">Tracking</span> <span class="pre">Data</span> <span class="pre">subtab</span></tt></p>
1761 </div>
1762 <div class="section" id="edit-file-download-guestbook">
1763 <h3>Edit File Download Guestbook<a class="headerlink" href="#edit-file-download-guestbook" title="Permalink to this headline">¶</a></h3>
1764 <p>You can set up a guestbook for your dataverse to collect information on
1765 all users before they can download or subset contents from the
1766 dataverse. The guestbook is independent of Terms of Use. Once it has
1767 been enabled it will be shown to any user for the first file a user
1768 downloads from a given study within a single session. If the user
1769 downloads additional files from the study in the same session a record
1770 will be created in the guestbook response table using data previously
1771 entered. Beginning with version 3.2 of Dataverse Network, if the
1772 dataverse guestbook is not enabled in your dataverse, download
1773 information will be collected silently based on logged-in user
1774 information or session ID.</p>
1775 <p>Navigate to the&nbsp;File Download Guestbook from the Options page:</p>
1776 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Guestbook</span> <span class="pre">subtab</span></tt></p>
1777 <p>To set up a Guestbook for downloading or subsetting contents from any study in the dataverse:</p>
1778 <ol class="arabic simple">
1779 <li>Click the Enable File Download Guestbook check box.</li>
1780 <li>Select or unselect required for any of the user account identifying
1781 data points (First and last name, E-Mail address, etc.)</li>
1782 <li>Add any custom questions to collect additional data. These questions
1783 may be marked as required and set up as free text responses or
1784 multiple choice. For multiple choice responses select Radio Buttons
1785 as the Custom Field Type and enter the possible answers.</li>
1786 <li>Any custom question may be removed at any time, so that it won’t show
1787 for the end user. If there are any responses associated with question
1788 that has been removed they will continue to appear in the Guestbook
1789 Response data table.</li>
1790 </ol>
1791 </div>
1792 <div class="section" id="openscholar">
1793 <span id="id6"></span><h3>OpenScholar<a class="headerlink" href="#openscholar" title="Permalink to this headline">¶</a></h3>
1794 <p><strong>Embed your Dataverse easily on an OpenScholar site</strong></p>
1795 <p>Dataverse integrates seamlessly with
1796 <a class="reference external" href="http://openscholar.harvard.edu/">OpenScholar</a>, a self-service site builder for higher education.</p>
1797 <p>To embed your dataverse on an OpenScholar site:</p>
1798 <ol class="arabic simple">
1799 <li>On your Dataverse Options page, Go to the Setting tab</li>
1800 <li>Go to the Customization subtab</li>
1801 <li>Click the checkbox that disables customization for your dataverse</li>
1802 <li>Make note of your Dataverse alias URL (i.e.
1803 <a class="reference external" href="http://thedata.harvard.edu/dvn/dv/myvalue">http://thedata.harvard.edu/dvn/dv/myvalue</a>)</li>
1804 <li>Follow the <a class="reference external" href="http://support.openscholar.harvard.edu/customer/portal/articles/1215076-apps-dataverse">OpenScholar Support Center
1805 instructions</a>&nbsp;to
1806 enable the Dataverse App</li>
1807 </ol>
1808 </div>
1809 <div class="section" id="enabling-lockss-access-to-the-dataverse">
1810 <span id="id7"></span><h3>Enabling LOCKSS access to the Dataverse<a class="headerlink" href="#enabling-lockss-access-to-the-dataverse" title="Permalink to this headline">¶</a></h3>
1811 <p><strong>Summary:</strong></p>
1812 <p><a class="reference external" href="http://lockss.stanford.edu/lockss/Home">LOCKSS Project</a> or <em>Lots
1813 of Copies Keeps Stuff Safe</em> is an international initiative based at
1814 Stanford University Libraries that provides a way to inexpensively
1815 collect and preserve copies of authorized e-content. It does so using an
1816 open source, peer-to-peer, decentralized server infrastructure. In order
1817 to make a LOCKSS server crawl, collect and preserve content from a DVN,
1818 both the server (the LOCKSS daemon) and the client (the DVN) sides must
1819 be properly configured. In simple terms, the LOCKSS server needs to be
1820 pointed at the DVN, given its location and instructions on what to
1821 crawl, the entire network, or a particular Dataverse; on the DVN side,
1822 access to the data must be authorized for the LOCKSS daemon. The section
1823 below describes the configuration tasks that the administrator of a
1824 Dataverse will need to do on the client side. It does not describe how
1825 LOCKSS works and what it does in general; it&#8217;s a fairly complex system,
1826 so please refer to the documentation on the <a class="reference external" href="http://lockss.stanford.edu/lockss/Home">LOCKSS
1827 Project</a> site for more
1828 information. Some information intended to a LOCKSS server administrator
1829 is available in the <a class="reference internal" href="dataverse-installer-main.html#using-lockss-with-dvn"><em>&#8220;Using LOCKSS with DVN&#8221;</em></a> of the <a class="reference internal" href="dataverse-installer-main.html#introduction"><em>DVN Installers Guide</em></a>
1830 (our primary sysadmin-level manual).</p>
1831 <p><strong>Configuration Tasks:</strong></p>
1832 <p>In order for a LOCKSS server to access, crawl and preserve any data on a
1833 given Dataverse Network, it needs to be granted an authorization by the
1834 network administrator. (In other words, an owner of a dataverse cannot
1835 authorize LOCKSS access to its files, unless LOCKSS access is configured
1836 on the Dataverse Network level). By default, LOCKSS crawling of the
1837 Dataverse Network is not allowed; check with the administrator of
1838 your&nbsp;Dataverse Network for details.</p>
1839 <p>But if enabled on the&nbsp;Dataverse Network level, the dataverse owner can
1840 further restrict LOCKSS access. For example, if on the network level all
1841 LOCKSS servers are allowed to crawl all publicly available data, the
1842 owner can limit access to the materials published in his or her
1843 dataverse to select servers only; specified by network address or
1844 domain.</p>
1845 <p>In order to configure LOCKSS access, navigate to the Advanced tab on the
1846 Options page:</p>
1847 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Advanced</span> <span class="pre">subtab</span></tt></p>
1848 <p>It&#8217;s important to understand that when a LOCKSS daemon is authorized to
1849 &#8220;crawl restricted files&#8221;, this does not by itself grant the actual
1850 access to the materials! This setting only specifies that the daemon
1851 should not be skipping such restricted materials outright. If it is
1852 indeed desired to have non-public materials collected and preserved by
1853 LOCKSS, in addition to selecting this option, it will be the
1854 responsibility of the DV Administrator to give the LOCKSS daemon
1855 permission to actually access the files.&nbsp;As of DVN version 3.3, this can
1856 only be done based on the IP address of the LOCKSS server (by creating
1857 an IP-based user group with the appropriate permissions).</p>
1858 <p>Once LOCKSS crawling of the Dataverse is enabled, the Manifest page
1859 URL will be</p>
1860 <p><tt class="docutils literal"><span class="pre">http</span></tt><tt class="docutils literal"><span class="pre">://&lt;YOUR</span> <span class="pre">SERVER&gt;/dvn/dv/&lt;DV</span> <span class="pre">ALIAS&gt;/faces/ManifestPage.xhtml</span></tt>.</p>
1861 </div>
1862 </div>
1863 <div class="section" id="study-and-data-administration">
1864 <h2>Study and Data Administration<a class="headerlink" href="#study-and-data-administration" title="Permalink to this headline">¶</a></h2>
1865 <p>Study Options are available for Contributors, Curators, and
1866 Administrators of a Dataverse.</p>
1867 <div class="section" id="create-new-study">
1868 <h3>Create New Study<a class="headerlink" href="#create-new-study" title="Permalink to this headline">¶</a></h3>
1869 <p>Brief instructions for creating a study:</p>
1870 <p>Navigate to the dataverse in which you want to create a study, then
1871 click Options-&gt;Create New Study.</p>
1872 <p>Enter at minimum a study title and click Save. Your draft study is now
1873 created. Add additional cataloging information and upload files as
1874 needed. Release the study when ready to make it viewable by others.</p>
1875 <p><strong>Data Citation widget</strong></p>
1876 <p>At the top of the edit study form, there is a data citation widget that
1877 allows a user to quickly enter fields that appear in the data citation,
1878 ie. title, author, date, distributor Otherwise, the information can be
1879 entered as the fields appear in the data entry form.</p>
1880 <p>See the information below for more details and recommendations for
1881 creating a study.</p>
1882 <p><strong>Steps to Create a Study</strong></p>
1883 <ol class="arabic simple">
1884 <li>Enter Cataloging Information, including an abstract of the study.
1885 Set Terms of Use for the study in the Cataloging fields, if you choose.</li>
1886 <li>Upload files associated with the study.</li>
1887 <li>Set permissions to access the study, all of the study files, or some
1888 of the study files.</li>
1889 <li>Delete your study if you choose, before you submit it for review.</li>
1890 <li>Submit your study for review, to make it available to the public.</li>
1891 </ol>
1892 <p>There are several guidelines to creating a study:</p>
1893 <ul class="simple">
1894 <li>You must create a study by performing steps in the specified order.</li>
1895 <li>If multiple users edit a study at one time, the first user to click
1896 Save assumes control of the file. Only that user&#8217;s changes are
1897 effective.</li>
1898 <li>When you save the study, any changes that you make after that do not
1899 effect the study&#8217;s citation.</li>
1900 </ul>
1901 <p><strong>Enter Cataloging Information</strong></p>
1902 <p>To enter the Cataloging Information for a new study:</p>
1903 <ol class="arabic">
1904 <li><p class="first">Prepopulate Cataloging Information fields based on a study template
1905 (if a template is available), use the Select Study Template pull-down
1906 list to select the appropriate template.</p>
1907 <p>A template provides default values for basic fields in the
1908 Cataloging Information fields. The default template prepopulates the
1909 Deposit Date field only.</p>
1910 </li>
1911 <li><p class="first">Enter a title in the Title field.</p>
1912 </li>
1913 <li><p class="first">Enter data in the remaining Cataloging Information fields.
1914 To list all fields, including the Terms of Use fields, click the Show
1915 All Fields button after you enter a title. Use the following
1916 guidelines to complete these fields:</p>
1917 <ul class="simple">
1918 <li>A light blue background in any form field indicates that HTML,
1919 JavaScript, and style tags are permitted. You cannot use the
1920 <tt class="docutils literal"><span class="pre">html</span></tt> and <tt class="docutils literal"><span class="pre">body</span></tt> element types.</li>
1921 <li>To use the inline help and view information about a field, roll
1922 your cursor over the field title.</li>
1923 <li>Be sure to complete the Abstract field.</li>
1924 <li>To set Terms of Use for your study, scroll to the bottom of the Cataloging Information tab.
1925 Eight fields appear under the Terms of Use label. You must
1926 complete at least one of these fields to enable Terms for this
1927 study.</li>
1928 </ul>
1929 </li>
1930 <li><p class="first">Click the <em>Save</em> button and then add comments or a brief description
1931 in the Study Version Notes popup. Then click the <em>Continue</em> button
1932 and your study draft version is saved.</p>
1933 </li>
1934 </ol>
1935 <p><strong>Upload Study Files</strong></p>
1936 <p>To upload files associated with a new study:</p>
1937 <ol class="arabic">
1938 <li><p class="first">For each file that you choose to upload to your study, first select
1939 the Data Type from the drop-down list. Then click the Browse button
1940 to select the file, and then click Upload to add each file at a time.</p>
1941 <p>When selecting a CSV (character-separated values) data type, an SPSS Control Card file is first required.</p>
1942 <p>When selecting a TAB (tab-delimited) data type, a DDI Control Card file is first required. There is no restriction to the number or types of files that you can upload to the Dataverse Network.</p>
1943 <p>There is a maximum file size of 2 gigabytes for each file that you upload.</p>
1944 </li>
1945 <li><p class="first">After you upload one file, enter the type of file in the <em>Category</em>
1946 field and then click Save.
1947 If you do not enter a category and click Save, the Category
1948 drop-down list does not have any value. You can create any category
1949 to add to this list.</p>
1950 </li>
1951 <li><p class="first">For each file that you upload, first click the check box in front of
1952 the file&#8217;s entry in the list, and then use the Category drop-down
1953 list to select the type of file that you uploaded.</p>
1954 <p>Every checked file is assigned the category that you select. Be sure
1955 to click the checked box to remove the check before you select a new
1956 value in the Category list for another file.</p>
1957 </li>
1958 <li><p class="first">In the Description field, enter a brief message that identifies the
1959 contents of your file.</p>
1960 </li>
1961 <li><p class="first">Click Save when you are finished uploading files. <strong>Note:</strong> If you upload a subsettable file, that process takes a few
1962 moments to complete. During the upload, the study is not available for editing. When you receive e-mail notification that the
1963 subsettable file upload is complete, click <em>Refresh</em> to continue editing the study.</p>
1964 <p>You see the Documentation, Data and Analysis tab of the study page
1965 with a list of the uploaded files. For each <em>subsettable tabular</em>
1966 data set file that you upload, the number of cases and variables and
1967 a link to the Data Citation information for that data set are
1968 displayed. If you uploaded an SPSS (<tt class="docutils literal"><span class="pre">.sav</span></tt> or <tt class="docutils literal"><span class="pre">.por</span></tt>) file, the
1969 Type for that file is changed to <em>Tab delimited</em> and the file
1970 extension is changed to <tt class="docutils literal"><span class="pre">.tab</span></tt> when you click Save.</p>
1971 <p>For each <em>subsettable network</em> data set file that you upload, the number of edges and verticies and a link to the Data Citation
1972 information for that data set are displayed.</p>
1973 </li>
1974 <li><p class="first">Continue to the next step and set file permissions for the study or
1975 its files.</p>
1976 </li>
1977 </ol>
1978 <p><strong>Study File Tips</strong></p>
1979 <p>Keep in mind these tips when uploading study files to your dataverse:</p>
1980 <ul class="simple">
1981 <li>The following subsettable file types are supported:<ul>
1982 <li>SPSS <tt class="docutils literal"><span class="pre">sav</span></tt> and <tt class="docutils literal"><span class="pre">por</span></tt> - Versions 7.x to 20.x (See the <a class="reference internal" href="#spss-datafile-ingest"><em>Note on SPSS ingest</em></a> in the Appendix)</li>
1983 <li>STATA <tt class="docutils literal"><span class="pre">dta</span></tt> - Versions 4 to 12</li>
1984 <li>R <tt class="docutils literal"><span class="pre">RData</span></tt> - All versions (NEW as of DVN v.3.5! See <a class="reference internal" href="#r-datafile-ingest"><em>Ingest of R data files</em></a> in the Appendix)</li>
1985 <li>GraphML <tt class="docutils literal"><span class="pre">xml</span></tt> - All versions</li>
1986 <li>CSV data file with a <a class="reference internal" href="#controlcard-datafile-ingest"><em>control card</em></a></li>
1987 <li>TAB-delimited data file with a <a class="reference internal" href="#ddixml-datafile-ingest"><em>DDI XML control card</em></a></li>
1988 </ul>
1989 </li>
1990 <li>A custom ingest for FITS Astronomical data files has been added in v.3.4. (see <a class="reference internal" href="#fits-datafile-ingest"><em>FITS File format Ingest</em></a> in the Appendix)</li>
1991 <li>You can add information for each file, including:<ul>
1992 <li>File name</li>
1993 <li>Category (documentation or data)</li>
1994 <li>Description</li>
1995 </ul>
1996 </li>
1997 <li>If you upload the wrong file, click the Remove link before you click
1998 Save.
1999 To replace a file after you upload it and save the study, first
2000 remove the file and then upload a new one.</li>
2001 <li>If you upload a STATA (<tt class="docutils literal"><span class="pre">.dta</span></tt>), SPSS (<tt class="docutils literal"><span class="pre">.sav</span></tt> or <tt class="docutils literal"><span class="pre">.por</span></tt>), or
2002 network (<tt class="docutils literal"><span class="pre">.xml</span></tt>) file, the file automatically becomes subsettable
2003 (that is, subset and analysis tools are available for that file in
2004 the Network). In this case, processing the file might take some time
2005 and you will not see the file listed immediately after you click
2006 Save.</li>
2007 <li>When you upload a <em>subsettable</em> data file, you are prompted to
2008 provide or confirm your e-mail address for notifications. One e-mail
2009 lets you know that the file upload is in progress; a second e-mail
2010 notifies you when the file upload is complete.</li>
2011 <li>While the upload of the files takes place, your study is not
2012 available for editing. When you receive e-mail notification that the
2013 upload is completed, click <em>Refresh</em> to continue editing the study.</li>
2014 </ul>
2015 <p><strong>Set Study and File Permissions</strong></p>
2016 <p>You can restrict access to a study, all of its files, or some of its
2017 files. This restriction extends to the search and browse functions.</p>
2018 <p>To permit or restrict access:</p>
2019 <ol class="arabic">
2020 <li><p class="first">On the study page, click the Permissions link.</p>
2021 </li>
2022 <li><p class="first">To set permissions for the study:</p>
2023 <ol class="upperalpha simple">
2024 <li>Scroll to the Entire Study Permission Settings panel, and click
2025 the drop-down list to change the study to Restricted or Public.</li>
2026 <li>In the <em>User Restricted Study Settings</em> field, enter a user or
2027 group to whom you choose to grant access to the study, then click
2028 Add.</li>
2029 </ol>
2030 <p>To enable a request for access to restricted files in the study,
2031 scroll to the File Permission Settings panel, and click the
2032 Restricted File Settings check box. This supplies a request link on
2033 the Data, Documentation and Analysis tab for users to request access
2034 to restricted files by creating an account.</p>
2035 <p>To set permission for individual files in the study:</p>
2036 <ol class="upperalpha simple">
2037 <li>Scroll to the Individual File Permission Settings panel, and enter
2038 a user or group in the Restricted File User Access <em>Username</em>
2039 field to grant permissions to one or more individual files.</li>
2040 <li>Use the File Permission pull-down list and select the permission
2041 level that you choose to apply to selected files: Restricted or
2042 Public.</li>
2043 <li>In the list of files, click the check box for each file to which
2044 you choose to apply permissions.
2045 To select all files, click the check box at the top of the list.</li>
2046 <li>Click Update.
2047 The users or groups to which you granted access privileges appear
2048 in the File Permissions list after the selected files.</li>
2049 </ol>
2050 </li>
2051 </ol>
2052 <p>Note: You can edit or delete your study if you choose, but only until
2053 you submit the study for reveiw. After you submit your study for review,
2054 you cannot edit or delete it from the dataverse.</p>
2055 <p><strong>Delete Studies</strong></p>
2056 <p>You can delete a study that you contribute, but only until you submit
2057 that study for review. After you submit your study for review, you
2058 cannot delete it from the dataverse.</p>
2059 <p>If a study is no longer valid, it can now be deaccessioned so it&#8217;s
2060 unavailable to users but still has a working citation. A reference to a
2061 new study can be provided when deaccessioning a study. Only Network
2062 Administrators can now permanently delete a study once it has been
2063 released.</p>
2064 <p>To delete a draft version:</p>
2065 <ol class="arabic">
2066 <li><p class="first">Click the Delete Draft Version link in the top-right area of the
2067 study page.</p>
2068 <p>You see the Delete Draft Study Version popup.</p>
2069 </li>
2070 <li><p class="first">Click the Delete button to remove the draft study version from the
2071 dataverse.</p>
2072 </li>
2073 </ol>
2074 <p>To deaccession a study:</p>
2075 <ol class="arabic">
2076 <li><dl class="first docutils">
2077 <dt>Click the Deaccession link in the top-right area of the study page.</dt>
2078 <dd><p class="first last">You see the Deaccession Study page.</p>
2079 </dd>
2080 </dl>
2081 </li>
2082 <li><p class="first">You have the option to add your comments about why the study was
2083 deaccessioned, and a link reference to a new study by including the
2084 Global ID of the study.</p>
2085 </li>
2086 <li><p class="first">Click the Deaccession button to remove your study from the
2087 dataverse.</p>
2088 </li>
2089 </ol>
2090 <p><strong>Submit Study for Review</strong></p>
2091 <p>When you finish setting options for your study, click <em>Submit For
2092 Review</em> in the top-right corner of the study page. The page study
2093 version changes to show <em>In Review</em>.</p>
2094 <p>You receive e-mail after you click <em>Submit For Review</em>, notifying you
2095 that your study was submitted for review by the Curator or Dataverse
2096 Admin. When a study is in review, it is not available to the public. You
2097 receive another e-mail notifying you when your study is released for
2098 public use.</p>
2099 <p>After your study is reviewed and released, it is made available to the
2100 public, and it is included in the search and browse functions. The
2101 Cataloging Information tab for your study contains the Citation
2102 Information for the complete study. The Documentation, Data and Analysis
2103 tab lists the files associated with the study. For each subsettable file
2104 in the study, a link is available to show the Data Citation for that
2105 specific data set.</p>
2106 <p><strong>UNF Calculation</strong></p>
2107 <p>When a study is created, a UNF is calculated for each subsettable file
2108 uploaded to that study. All subsettable file UNFs then are combined to
2109 create another UNF for the study. If you edit a study and upload new
2110 subsettable files, a new UNF is calculated for the new files and for the
2111 study.</p>
2112 <p>If the original study was created before version 2.0 of the Dataverse
2113 Network software, the UNF calculations were performed using version 3 of
2114 that standard. If you upload new subsettable files to an existing study
2115 after implementation of version 2.0 of the software, the UNFs are
2116 recalculated for all subsettable files and for the study using version 5
2117 of that standard. This prevents incompatibility of UNF version numbers
2118 within a study.</p>
2119 </div>
2120 <div class="section" id="manage-studies">
2121 <h3>Manage Studies<a class="headerlink" href="#manage-studies" title="Permalink to this headline">¶</a></h3>
2122 <p>You can find all studies that you uploaded to the dataverse, or that
2123 were submitted by a Contributor for review. Giving you access to view,
2124 edit, release, or delete studies.</p>
2125 <p><strong>View, Edit, and Delete/Deaccession Studies</strong></p>
2126 <p>To view and edit studies that you uploaded:</p>
2127 <ol class="arabic simple">
2128 <li>Click a study Global ID, title, or <em>Edit</em> link to go to the study
2129 page.</li>
2130 <li>From the study page, do any of the following:<ul>
2131 <li>Edit Cataloging Information</li>
2132 <li>Edit/Delete File + Information</li>
2133 <li>Add File(s)</li>
2134 <li>Edit Study Version Notes</li>
2135 <li>Permissions</li>
2136 <li>Create Study Template</li>
2137 <li>Release</li>
2138 <li>Deaccession</li>
2139 <li>Destroy Study</li>
2140 </ul>
2141 </li>
2142 </ol>
2143 <p>To delete or deaccession studies that you uploaded:</p>
2144 <ol class="arabic simple">
2145 <li>If the study has not been released, click the <em>Delete</em> link to open
2146 the Delete Draft Study Version popup.</li>
2147 <li>If the study has been released, click the <em>Deaccession</em> link to open
2148 the Deaccession Study page.</li>
2149 <li>Add your comments about why the study was deaccessioned, and a
2150 reference link to another study by including the Global ID, then
2151 click the <em>Deaccession</em> button.</li>
2152 </ol>
2153 <p><strong>Release Studies</strong></p>
2154 <p>When you release a study, you make it available to the public. Users can
2155 browse it or search for it from the dataverse or Network homepage.</p>
2156 <p>You receive e-mail notification when a Contributor submits a study for
2157 review. You must review each study submitted to you and release that
2158 study to the public. You receive a second e-mail notification after you
2159 release a study.</p>
2160 <p>To release a study draft version:</p>
2161 <ol class="arabic simple">
2162 <li>Review the study draft version by clicking the Global ID, or title,
2163 to go to the Study Page, then click Release in the upper right
2164 corner. For a quick release, click <em>Release</em> from the Manage Studies
2165 page.</li>
2166 <li>If the study draft version is an edit of an existing study, you will
2167 see the Study Version Differences page. The table allows you to view
2168 the changes compared to the current public version of the study.
2169 Click the <em>Release</em> button to continue.</li>
2170 <li>Add comments or a brief description in the Study Version Notes popup.
2171 Then click the <em>Continue</em> button and your study is now public.</li>
2172 </ol>
2173 </div>
2174 <div class="section" id="manage-study-templates">
2175 <h3>Manage Study Templates<a class="headerlink" href="#manage-study-templates" title="Permalink to this headline">¶</a></h3>
2176 <p>You can set up study templates for a dataverse to prepopulate any of
2177 the Cataloging Information fields of a new study with default values.
2178 When a user adds a new study, that user can select a template to fill in
2179 the defaults.</p>
2180 <p><strong>Create Template</strong></p>
2181 <p>Study templates help to reduce the work needed to add a study, and to
2182 apply consistency to studies within a dataverse. For example, you can
2183 create a template to include the Distributor and Contact details so that
2184 every study has the same values for that metadata.</p>
2185 <p>To create a new study template:</p>
2186 <ol class="arabic simple">
2187 <li>Click Clone on any Template.</li>
2188 <li>You see the Study Template page.</li>
2189 <li>In the Template Name field, enter a descriptive name for this
2190 template.</li>
2191 <li>Enter generic information in any of the Cataloging Information
2192 metadata fields. &nbsp;You may also change the input level of any field to
2193 make a certain field required, recommended, optional or hidden.
2194 &nbsp;Hidden fields will not be visible to the user creating studies from
2195 the template.</li>
2196 <li>After you complete entry of generic details in the fields that you
2197 choose to prepopulate for new studies, click Save to create the
2198 template.</li>
2199 </ol>
2200 <p>Note: You also can create a template directly from the study page to
2201 use that study&#8217;s Cataloging Information in the template.</p>
2202 <p><strong>Enable a template</strong></p>
2203 <p>Click the Enabled link for the given template. Enabled templates are
2204 available to end users for creating studies.</p>
2205 <p><strong>Edit Template</strong></p>
2206 <p>To edit an existing study template:</p>
2207 <ol class="arabic simple">
2208 <li>In the list of templates, click the Edit link for the template that
2209 you choose to edit.</li>
2210 <li>You see the Study Template page, with the template setup that you
2211 selected.</li>
2212 <li>Edit the template fields that you choose to change, add, or remove.</li>
2213 </ol>
2214 <p>Note: You cannot edit any Network Level Template.</p>
2215 <p><strong>Make a Template the Default</strong></p>
2216 <p>To set any study template as the default template that applies
2217 automatically to new studies:
2218 In the list of templates, click the Make Default link next to the name
2219 of the template that you choose to set as the default.
2220 | The Current Default Template label is displayed next to the name of
2221 the template that you set as the default.</p>
2222 <div class="line-block">
2223 <div class="line"><strong>Remove Template</strong></div>
2224 <div class="line">To delete a study template from a dataverse:</div>
2225 </div>
2226 <ol class="arabic simple">
2227 <li>In the list of templates, click the Delete link for the template that
2228 you choose to remove from the dataverse.</li>
2229 <li>You see the Delete Template page.</li>
2230 <li>Click Delete to remove the template from the dataverse.</li>
2231 </ol>
2232 <p>Note: &nbsp;You cannot delete any network template, default template or
2233 template in use by any study.</p>
2234 </div>
2235 <div class="section" id="data-uploads">
2236 <h3>Data Uploads<a class="headerlink" href="#data-uploads" title="Permalink to this headline">¶</a></h3>
2237 <p><strong>Troubleshooting Data Uploads:</strong></p>
2238 <p>Though the add files page works for the majority of our users, there can
2239 be situations where uploading files does not work. Below are some
2240 troubleshooting tips, including situations where uploading a file might
2241 fail and things to try.</p>
2242 <p><strong>Situations where uploading a file might fail:</strong></p>
2243 <ol class="arabic simple">
2244 <li>File is too large, larger than the maximum size, should fail immediately with an error.</li>
2245 <li>File takes too long and connection times out (currently this seems to happen after 5 mins) Failure behavior is vague, depends
2246 on browser. This is probably an IceFaces issue.</li>
2247 <li>User is going through a web proxy or firewall that is not passing through partial submit headers. There is specific failure
2248 behavior here that can be checked and it would also affect other web site functionality such as create account link. See
2249 redmine ticket <a class="reference external" href="https://redmine.hmdc.harvard.edu/issues/2532">#2352</a>.</li>
2250 <li>AddFilesPage times out, user begins adding files and just sits there idle for a long while until the page times out, should
2251 see the red circle slash.</li>
2252 <li>For subsettable files, there is something wrong with the file
2253 itself and so is not ingested. In these cases they should upload as other and we can test here.</li>
2254 <li>For subsettable files, there is something wrong with our ingest code that can&#8217;t process something about that particular file,
2255 format, version.</li>
2256 <li>There is a browser specific issue that is either a bug in our
2257 software that hasn&#8217;t been discovered or it is something unique to their browser such as security settings or a conflict with a
2258 browser plugin like developer tools. Trying a different browser such as Firefox or Chrome would be a good step.</li>
2259 <li>There is a computer or network specific issue that we can&#8217;t determine such as a firewall, proxy, NAT, upload versus download
2260 speed, etc. Trying a different computer at a different location might be a good step.</li>
2261 <li>They are uploading a really large subsettable file or many files and it is taking a really long time to upload.</li>
2262 <li>There is something wrong with our server such as it not responding.</li>
2263 <li>Using IE 8, if you add 2 text or pdf files in a row it won&#8217;t upload but if you add singly or also add a subsettable file they
2264 all work. Known issue, reported previously, <a class="reference external" href="https://redmine.hmdc.harvard.edu/issues/2367">#2367</a></li>
2265 </ol>
2266 <p><strong>So, general information that would be good to get and things to try would be:</strong></p>
2267 <ol class="arabic simple">
2268 <li>Have you ever been able to upload a file?</li>
2269 <li>Does a small text file work?</li>
2270 <li>Which browser and operating system are you using? Can you try Firefox or Chrome?</li>
2271 <li>Does the problem affect some files or all files? If some files, do they work one at a time? Are they all the same type such as
2272 Stata or SPSS? Which version? Can they be saved as a supported version, e.g. Stata 12 or SPSS 20? Upload them as type &#8220;other&#8221;
2273 and we&#8217;ll test here.</li>
2274 <li>Can you try a different computer at a different location?</li>
2275 <li>Last, we&#8217;ll try uploading it for you (may need DropBox to facilitate upload).</li>
2276 </ol>
2277 </div>
2278 <div class="section" id="manage-collections">
2279 <span id="id8"></span><h3>Manage Collections<a class="headerlink" href="#manage-collections" title="Permalink to this headline">¶</a></h3>
2280 <p>Collections can contain studies from your own dataverse or another,
2281 public dataverse in the Network.</p>
2282 <p><strong>Create Collection</strong></p>
2283 <p>You can create new collections in your dataverse, but any new collection
2284 is a child of the root collection except for Collection Links. When you
2285 create a child in the root collection, you also can create a child
2286 within that child to make a nested organization of collections. The root
2287 collection remains the top-level parent to all collections that are not
2288 linked from another dataverse.</p>
2289 <p>There are three ways in which you can create a collection:</p>
2290 <ul class="simple">
2291 <li>Static collection - You assign specific studies to this type of
2292 collection.</li>
2293 <li>Dynamic collection - You can create a query that gathers studies into
2294 a collection based on matching criteria, and keep the contents
2295 current. If a study matches the query selection criteria one week,
2296 then is changed and no longer matches the criteria, that study is
2297 only a member of the collection as long as it&#8217;s criteria matches the
2298 query.</li>
2299 <li>Linked collection - You can link an existing collection from another
2300 dataverse to your dataverse homepage. Note that the contents of that
2301 collection can be edited only in the originating dataverse.</li>
2302 </ul>
2303 <p><strong>Create Static Collection by Assigning Studies</strong></p>
2304 <p>To create a collection by assigning studies directly to it:</p>
2305 <ol class="arabic">
2306 <li><p class="first">Locate the root collection to create a direct subcollection in the
2307 root, or locate any other existing collection in which you choose
2308 create a new collection. Then, click the <em>Create</em> link in the Create
2309 Child field for that collection.</p>
2310 <p>You see the Study Collection page.</p>
2311 </li>
2312 <li><p class="first">In the Type field, click the Static option.</p>
2313 </li>
2314 <li><p class="first">Enter your collection Name.</p>
2315 </li>
2316 <li><p class="first">Select the Parent in which you choose to create the collection.
2317 The default is the collection in which you started on the <em>Manage
2318 Collections</em> page. You cannot create a collection in another
2319 dataverse unless you have permission to do so.</p>
2320 </li>
2321 <li><p class="first">Populate the Selected Studies box:</p>
2322 <ul class="simple">
2323 <li>Click the <em>Browse</em> link to use the Dataverse and Collection
2324 pull-down lists to create a list of studies.</li>
2325 <li>Click the <em>Search</em> link to select a query field and search for
2326 specific studies, enter a term to search for in that query field,
2327 and then click Search.</li>
2328 </ul>
2329 <p>A list of available studies is displayed in the Studies to Choose
2330 from box.</p>
2331 </li>
2332 <li><p class="first">In the Studies to Choose from box, click a study to assign it to your
2333 collection.</p>
2334 <p>You see the study you clicked in the Selected Studies box.</p>
2335 </li>
2336 <li><p class="first">To remove studies from the list of Selected Studies, click the study
2337 in that box.</p>
2338 <p>The study is remove from the Selected Studies box.</p>
2339 </li>
2340 <li><p class="first">If needed, repopulate the Studies to Choose from box with new
2341 studies, and add additional studies to the Studies Selected list.</p>
2342 </li>
2343 </ol>
2344 <p><strong>Create Linked Collection</strong></p>
2345 <p>You can create a collection as a link to one or more collections from
2346 other dataverses, thereby defining your own collections for users to
2347 browse in your dataverse.</p>
2348 <p>Note: A collection created as a link to a collection from another
2349 dataverse is editable only in the originating dataverse. Also,
2350 collections created by use of this option might not adhere to the
2351 policies for adding Cataloging Information and study files that you
2352 require in your own dataverse.</p>
2353 <p>To create a collection as a link to another collection:</p>
2354 <ol class="arabic">
2355 <li><p class="first">In the Linked Collections field, click Add Collection Link.</p>
2356 <p>You see the Add Collection Link window.</p>
2357 </li>
2358 <li><p class="first">Use the Dataverse pull-down list to select the dataverse from which
2359 you choose to link a collection.</p>
2360 </li>
2361 <li><p class="first">Use the Collection pull-down list to select a collection from your
2362 selected dataverse to add a link to that collection in your
2363 dataverse.</p>
2364 <p>The collection you select will be displayed in your dataverse
2365 homepage, and will be included in your dataverse searches.</p>
2366 </li>
2367 </ol>
2368 <p><strong>Create Dynamic Collection as a Query</strong></p>
2369 <p>When you create a collection by assigning the results of a query to it,
2370 that collection is dynamic and is updated regularly based on the query
2371 results.</p>
2372 <p>To create a collection by assigning the results of a query:</p>
2373 <ol class="arabic">
2374 <li><p class="first">Locate the root collection to create a direct subcollection in the
2375 root, or locate any other existing collection in which you choose
2376 create a new collection. Then, click the <em>Create</em> link in the Create
2377 Child field for that collection.</p>
2378 <p>You see the Study Collection page.</p>
2379 </li>
2380 <li><p class="first">In the Type field, click the Dynamic option.</p>
2381 </li>
2382 <li><p class="first">Enter your collection Name.</p>
2383 </li>
2384 <li><p class="first">Select the Parent in which you choose to create the collection.</p>
2385 <p>The default is the collection in which you started on the <em>Manage Collections</em> page. You cannot create a collection in another
2386 dataverse unless you have permission to do so.</p>
2387 </li>
2388 <li><p class="first">Enter a Description of this collection.</p>
2389 </li>
2390 <li><p class="first">In the Enter query field, enter the study field terms for which to
2391 search to assign studies with those terms to this collection.
2392 Use the following guidelines:</p>
2393 <ul>
2394 <li><p class="first">Almost all study fields can be used to build a collection query.</p>
2395 <p>The study fields must be entered in the appropriate format to
2396 search the fields&#8217; contents.</p>
2397 </li>
2398 <li><p class="first">Use the following format for your query:
2399 <tt class="docutils literal"><span class="pre">title:Elections</span> <span class="pre">AND</span> <span class="pre">keywordValue:world</span></tt>.</p>
2400 <p>For more information on query syntax, refer to the
2401 <a class="reference external" href="http://lucene.apache.org/java/docs/">Documentation</a> page at
2402 the Lucene website and look for <em>Query Syntax</em>. See the
2403 <a class="reference external" href="http://guides.thedata.org/files/thedatanew_guides/files/catalogingfields11apr08.pdf">cataloging fields</a>
2404 document for field query names.</p>
2405 </li>
2406 <li><p class="first">For each study in a dataverse, the Study Global Id field in the
2407 Cataloging Information consists of three query terms:
2408 <tt class="docutils literal"><span class="pre">protocol</span></tt>, <tt class="docutils literal"><span class="pre">authority</span></tt>, and <tt class="docutils literal"><span class="pre">globalID</span></tt>.</p>
2409 <p>If you build a query using <tt class="docutils literal"><span class="pre">protocol</span></tt>, your collection can
2410 return any study that uses the <tt class="docutils literal"><span class="pre">protocol</span></tt> you specified.</p>
2411 <p>If you build a query using all three terms, you collection
2412 returns only one study.</p>
2413 </li>
2414 </ul>
2415 </li>
2416 <li><p class="first">To limit this collection to search for results in your own dataverse,
2417 click the <em>Only your dataverse</em> check box.</p>
2418 </li>
2419 </ol>
2420 <p><strong>Edit Collections</strong></p>
2421 <ol class="arabic">
2422 <li><p class="first">Click a collection title to edit the contents or setup of that
2423 collection.</p>
2424 <p>You see the Collection page, with the current collection settings
2425 applied.</p>
2426 </li>
2427 <li><p class="first">Change, add, or delete any settings that you choose, and then click
2428 Save Collection to save your edits.</p>
2429 </li>
2430 </ol>
2431 <p><strong>Delete Collections or Remove Links</strong></p>
2432 <p>To delete existing static or dynamic collections:</p>
2433 <ol class="arabic simple">
2434 <li>For the collection that you choose to delete, click the Delete link.</li>
2435 <li>Confirm the delete action to remove the collection from your
2436 dataverse.</li>
2437 </ol>
2438 <p>To remove existing linked collections:</p>
2439 <ol class="arabic simple">
2440 <li>For the linked collection that you choose to remove, click the
2441 <em>Remove</em> link. (Note: There is no confirmation for a Remove action.
2442 When you click the Remove link, the Dataverse Network removes the linked collection immediately.)</li>
2443 </ol>
2444 </div>
2445 <div class="section" id="managing-user-file-access">
2446 <h3>Managing User File Access<a class="headerlink" href="#managing-user-file-access" title="Permalink to this headline">¶</a></h3>
2447 <p>User file access is managed through a set of access permissions that
2448 together determines whether or not a user can access a particular file,
2449 study, or dataverse. Generally speaking, there are three places where
2450 access permissions can be configured: at the dataverse level, at the
2451 study level, and at the file level. Think of each of these as a security
2452 perimeter or lock with dataverse being the outer most perimeter, study
2453 the next, and finally the file level. When configuring user file access,
2454 it might be helpful to approach this from the dataverse access level
2455 first and so on.</p>
2456 <p>For example, a user would like access to a particular file. Since files
2457 belong to studies and studies belong to dataverses, first determine
2458 whether the user has access to the dataverse. If the dataverse is
2459 released, all users have access to it. If it is unreleased, the user
2460 must appear in the User Permissions section on the dataverse permissions
2461 page.</p>
2462 <p>Next, they would need access to the study. If the study is public, then
2463 everyone has access. If it is restricted, the user must appear in the
2464 User Restricted Study Settings section on the study permissions page.</p>
2465 <p>Last, they would need access to the file. If the file is public,
2466 everyone has access. If the file is restricted, then the user must be
2467 granted access.</p>
2468 <p><strong>There are two ways a file can be restricted.</strong></p>
2469 <p>First, on the dataverse permissions page, all files in the dataverse
2470 could be restricted using Restrict ALL files in this Dataverse. To
2471 enable user access in this case, add the username to the Restricted File
2472 User Access section on this page.</p>
2473 <p>Second, individual files can be restricted at the study level on the
2474 study permissions page in the &#8220;Files&#8221; subtab. These can be restricted on a file-by-file basis.
2475 If this is the case, the file(s) will be displayed
2476 as restricted in the Individual File Permission Settings section. To
2477 enable user access to a particular file in this case, check the file to
2478 grant access to, type the username in the Restricted File User Access
2479 section, click update so their name appears next to the file, then click
2480 save.</p>
2481 <p>Another option at the study level when restricting files is to allow users the ability to
2482 request access to restricted files. This can be done in the study Permissions page in the &#8220;Files&#8221; subtab where
2483 you must first select the files you want to restrict, click on &#8220;update permissions&#8221; to restrict, and then under
2484 &#8220;File Permission Settings&#8221; check off the box to &#8220;Allow users to request access...&#8221; and click on Save at the bottom
2485 of the page. The contact(s) set for the Dataverse (<tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">Options</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">&gt;</span> <span class="pre">General</span></tt>) will get an email
2486 notification each time a user sends a request. The request access email will displays a list of the file(s)
2487 requested and a DOI or Handle for the study. To approve or deny access to these file(s) go back to the study
2488 permissions page under the &#8220;Files&#8221; subtab and Approve or Deny the specific files that were requested. If you
2489 choose to deny any files you will have the option to add a reason why. Be sure to remember to click on the &#8220;update&#8221;
2490 button and then select Save so that your selections are saved and an email is sent to the requestor granting or
2491 denying them access. The email then sent to the requestor will list out which files were approved with a DOI or
2492 Handle URL, and any files which were denied along with any reasons that may have been provided.</p>
2493 <p>Finally, a somewhat unusual configuration could exist where both
2494 Restrict all files in a dataverse is set and an individual file is
2495 restricted. In this case access would need to be granted in both places
2496 -think of it as two locks. This last situation is an artifact of
2497 integrating these two features and will be simplified in a future
2498 release.</p>
2499 </div>
2500 </div>
2501 <div class="section" id="network-administration">
2502 <h2>Network Administration<a class="headerlink" href="#network-administration" title="Permalink to this headline">¶</a></h2>
2503 <p>The Dataverse Network provides several options for configuring and
2504 customizing your application. To access these options, login to the
2505 Dataverse Network application with an account that has Network
2506 Administrator privileges. By default, a brand new installation of the
2507 application will include an account of this type - the username and
2508 password is &#8216;networkAdmin&#8217;.</p>
2509 <p>After you login, the Dataverse Network home page links to the Options
2510 page from the &#8220;Options&#8221; gear icon, in the menu bar. Click on the icon to
2511 view all the options available for customizing and configuring the
2512 applications, as well as some network adminstrator utilities.</p>
2513 <p>The following tasks can be performed from the Options page:</p>
2514 <ul class="simple">
2515 <li>Manage dataverses, harvesting, exporting, and OAI sets - Create,
2516 edit, and manage standard and harvesting dataverses, manage
2517 harvesting schedules, set study export schedules, and manage OAI
2518 harvesting sets.</li>
2519 <li>Manage subnetworks - Create, edit, and manage subnetworks, manage network and subnetwork level study templates.</li>
2520 <li>Customize the Network pages and description - Brand your Network and
2521 set up your Network e-mail contact.</li>
2522 <li>Set and edit Terms of Use - Apply Terms of Use at the Network level
2523 for accounts, uploads, and downloads.</li>
2524 <li>Create and manage user accounts and groups and Network privileges,
2525 and enable option to create a dataverse - Manage logins, permissions,
2526 and affiliate access to the Network.</li>
2527 <li>Use utilities and view software information - Use the administrative
2528 utilities and track the current Network installation.</li>
2529 </ul>
2530 <div class="section" id="dataverses-section">
2531 <h3>Dataverses Section<a class="headerlink" href="#dataverses-section" title="Permalink to this headline">¶</a></h3>
2532 <div class="section" id="create-a-new-dataverse">
2533 <h4>Create a New Dataverse<a class="headerlink" href="#create-a-new-dataverse" title="Permalink to this headline">¶</a></h4>
2534 <p>A dataverse is a container for studies and is the home for an individual
2535 scholar&#8217;s or organization&#8217;s data.</p>
2536 <p>Creating a dataverse is easy but first you must be a registered user.
2537 Depending on site policy, there may be a link on the Network home page,
2538 entitled &#8220;Create a Dataverse&#8221;. This first walks you through creating an
2539 account, then a dataverse. If this is not the case on your site, log in,
2540 then navigate to the Create a New Dataverse page and complete the
2541 required information. That&#8217;s it!</p>
2542 <ol class="arabic">
2543 <li><dl class="first docutils">
2544 <dt>Navigate to the Create a New Dataverse page:</dt>
2545 <dd><p class="first last">Network home page &gt; Options page &gt;Dataverses tab &gt; Dataverse subtab &gt; &#8220;Create Dataverse&#8221; link.</p>
2546 </dd>
2547 </dl>
2548 </li>
2549 <li><p class="first">Fill in the required information:</p>
2550 <blockquote>
2551 <div><p><strong>Type of Dataverse</strong></p>
2552 <p>Choose Scholar if it represents an individual&#8217;s work otherwise choose Basic.</p>
2553 <p><strong>Dataverse Name</strong></p>
2554 <p>This will be displayed on the network and dataverse home
2555 pages. If this is a Scholar dataverse it will automatically be
2556 filled in with the scholar&#8217;s first and last name.</p>
2557 <p><strong>Dataverse Alias</strong></p>
2558 <p>This is an abbreviation, usually lower-case, that becomes part of the URL for the new dataverse.</p>
2559 </div></blockquote>
2560 </li>
2561 <li><p class="first">Click Save and you&#8217;re done!</p>
2562 <p>An email will be sent to you with more information, including
2563 the url to access you new dataverse.</p>
2564 </li>
2565 </ol>
2566 <p><strong>Required information</strong> can vary depending on site policy. Required fields are noted with a red asterisk.</p>
2567 <p>Note: If &#8220;Allow users to create a new Dataverse when they create an account&#8221; is enabled, there is a Create a Dataverse link on the Network home page.</p>
2568 </div>
2569 <div class="section" id="manage-dataverses">
2570 <h4>Manage Dataverses<a class="headerlink" href="#manage-dataverses" title="Permalink to this headline">¶</a></h4>
2571 <p>As dataverses increase in number it&#8217;s useful to view summary information
2572 in table form and quickly locate a dataverse of interest. The Manage
2573 Dataverse table does just that.</p>
2574 <p>Navigate to Network home page &gt; Options page &gt; Dataverses tab &gt;
2575 Dataverses subtab &gt; Manage Dataverse table:</p>
2576 <ul class="simple">
2577 <li>Dataverses are listed in order of most recently created.</li>
2578 <li>Clicking on a column name sorts the list by that column such as Name
2579 or Affiliation.</li>
2580 <li>Clicking on a letter in the alpha selector displays only those
2581 dataverses beginning with that letter.</li>
2582 <li>Move through the list of dataverses by clicking a page number or the
2583 forward and back buttons.</li>
2584 <li>Click Delete to remove a dataverse.</li>
2585 </ul>
2586 </div>
2587 </div>
2588 <div class="section" id="subnetwork-section">
2589 <h3>Subnetwork Section<a class="headerlink" href="#subnetwork-section" title="Permalink to this headline">¶</a></h3>
2590 <p>A subnetwork is a container for a group of dataverses. Users will be able to create their dataverses in a particular subnetwork. It may include its own branding and its own custom study templates.</p>
2591 <div class="section" id="create-a-new-subnetwork">
2592 <h4>Create a New Subnetwork<a class="headerlink" href="#create-a-new-subnetwork" title="Permalink to this headline">¶</a></h4>
2593 <p>You must be a network admin in order to create a subnetwork. These are the steps to create a subnetwork:</p>
2594 <ol class="arabic">
2595 <li><dl class="first docutils">
2596 <dt>Navigate to Create a New Subnetwork Page:</dt>
2597 <dd><p class="first last">Network home page &gt; Options page &gt; Subnetworks tab&gt; Create Subnetwork Link</p>
2598 </dd>
2599 </dl>
2600 </li>
2601 <li><p class="first">Fill in required information:</p>
2602 <blockquote>
2603 <div><p><strong>Subnetwork Name</strong></p>
2604 <p>The name to be displayed in the menubar. Please use a short name.</p>
2605 <p><strong>Subnetwork Alias</strong></p>
2606 <p>Short name used to build the URL for this Subnetwork. It is case sensitive.</p>
2607 <p><strong>Subnetwork Short Description</strong></p>
2608 <p>This short description is displayed on the Network Home page</p>
2609 </div></blockquote>
2610 </li>
2611 <li><dl class="first docutils">
2612 <dt>Fill in Optional Branding</dt>
2613 <dd><p class="first last">These fields include a logo file, Subnetwork affiliation, description, and custom banner and footer.</p>
2614 </dd>
2615 </dl>
2616 </li>
2617 <li><p class="first">Click Save and you’re done!</p>
2618 </li>
2619 </ol>
2620 </div>
2621 <div class="section" id="manage-subnetworks">
2622 <h4>Manage Subnetworks<a class="headerlink" href="#manage-subnetworks" title="Permalink to this headline">¶</a></h4>
2623 <p>The Manage Subnetworks page gives summary information about all of the subnetworks in your installation.</p>
2624 <p>Navigate to Network home page &gt; Options Page &gt; Subnetworks tab:</p>
2625 <ul class="simple">
2626 <li>Subnetworks are listed alphabetically</li>
2627 <li>Clicking on a column name sorts the list by that column</li>
2628 <li>Click Edit to edit the subnetwork’s information or branding</li>
2629 <li>Click Delete to remove a subnetwork. Note: this will not remove the dataverses assigned to the subnetwork. The dataverses will remain and may be reassigned to another subnetwork.</li>
2630 </ul>
2631 </div>
2632 <div class="section" id="manage-classifications">
2633 <h4>Manage Classifications<a class="headerlink" href="#manage-classifications" title="Permalink to this headline">¶</a></h4>
2634 <p>Classifications are a way to organize dataverses on the network home
2635 page so they are more easily located. They appear on the left side of
2636 the page and clicking on a classification causes corresponding
2637 dataverses to be displayed. An example classification might be
2638 Organization, Government.</p>
2639 <p>Classifications typically form a hierarchy defined by the network
2640 administrator to be what makes sense for a particular site. A top level
2641 classification could be Organization, the next level Association,
2642 Business, Government, and School.</p>
2643 <p>The classification structure is first created on the Options page, from
2644 the Manage Classifications table. Once a classification is created,
2645 dataverses can be assigned to it either when the dataverse is first
2646 created or later from the Options page: Network home page &gt; (Your)
2647 Dataverse home page &gt; Options page &gt; Settings tab &gt; General subtab.</p>
2648 <p>To manage classifications, navigate to the Manage Classifications table:</p>
2649 <p>Network home page &gt; Options page &gt; Classifications tab &gt; Manage
2650 Classifications table</p>
2651 <p>From here you can view the current classification hierarchy, create a
2652 classification, edit an existing classification including changing its
2653 place in the hierarchy, and delete a classification.</p>
2654 </div>
2655 <div class="section" id="manage-study-comments-notifications">
2656 <h4>Manage Study Comments Notifications<a class="headerlink" href="#manage-study-comments-notifications" title="Permalink to this headline">¶</a></h4>
2657 <p>Dataverse admins can enable or disable a User Comment feature within
2658 their dataverses. If this feature is enabled, users are able to add
2659 comments to studies within that dataverse. Part of the User Comment
2660 feature is the ability for users to report comments as abuse if they
2661 deem that comment to be inappropriate in some way.</p>
2662 <p>Note that it is a best practice to explicitly define terms of use
2663 regarding comments when the User Comments feature is enabled. If you
2664 define those terms at the Network level, then any study to which
2665 comments are added include those terms.</p>
2666 <p>When a user reports another&#8217;s comment as abuse, that comment is listed
2667 on the Manage Study Comment Notifications table on the Options page. For
2668 each comment reported as abuse, you see the study&#8217;s Global ID, the
2669 comment reported, the user who posted the comment, and the user who
2670 reported the comment as abuse.</p>
2671 <p>There are two ways to manage abuse reports: In the Manage Study Comment
2672 Notifications table on the Options page, and on the study page User
2673 Comments tab. In both cases, you have the options to remove the comment
2674 or to ignore the abuse report.</p>
2675 <p>The Manage Study Comments Notifications table can be found here:</p>
2676 <p>Network home page &gt; Options page &gt; Dataverses tab &gt; Study Comments
2677 subtab &gt; Manage Study Comment Notifications table</p>
2678 </div>
2679 <div class="section" id="manage-controlled-vocabulary">
2680 <h4>Manage Controlled Vocabulary<a class="headerlink" href="#manage-controlled-vocabulary" title="Permalink to this headline">¶</a></h4>
2681 <p>You can set up controlled vocabulary for a dataverse network to give the
2682 end user a set list of choices to select from for most fields in a study
2683 template. Study fields which do not allow controlled vocabulary include
2684 the study title and subtitle, certain date fields and geographic
2685 boundaries.</p>
2686 <p>To <strong>manage controlled vocabulary</strong>, navigate to the Manage Controlled
2687 Vocabulary table:</p>
2688 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Vocabulary</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Manage</span> <span class="pre">Controlled</span> <span class="pre">Vocabulary</span> <span class="pre">table</span></tt></p>
2689 <p><strong>To create a new controlled vocabulary:</strong></p>
2690 <ol class="arabic simple">
2691 <li>Click Create New Controlled Vocabulary.</li>
2692 <li>You see the Edit Controlled Vocabulary page.</li>
2693 <li>In the Name field, enter a descriptive name for this Controlled
2694 Vocabulary. In the Description field enter any additional information
2695 that will make it easier to identify a particular controlled
2696 vocabulary item to assign to a given custom field. In the Values
2697 field enter the controlled vocabulary values that you want to make
2698 available to users for a study field. Here you can submit an entire list of terms at once. Use the &#8220;add&#8221; and &#8220;remove&#8221; buttons
2699 to add or subtract values from the list. You may also copy and paste a list of values separated by carriage returns.</li>
2700 <li>After you complete entry of values, click Save to create the
2701 controlled vocabulary.</li>
2702 </ol>
2703 <p><strong>Edit Controlled Vocabulary</strong></p>
2704 <p>To edit an existing controlled vocabulary:</p>
2705 <ol class="arabic simple">
2706 <li>In the list of controlled vocabulary, click the Edit link for the
2707 controlled vocabulary that you choose to edit. You see the Edit
2708 Controlled Vocabulary page, with the controlled vocabulary setup that
2709 you selected.</li>
2710 <li>Edit the controlled vocabulary items that you choose to change, add,
2711 or remove. You may also copy and paste a list of values separated by carriage returns.</li>
2712 </ol>
2713 </div>
2714 <div class="section" id="manage-network-study-templates">
2715 <h4>Manage Network Study Templates<a class="headerlink" href="#manage-network-study-templates" title="Permalink to this headline">¶</a></h4>
2716 <p>You can set up study templates for a dataverse network to prepopulate
2717 any of the Cataloging Information fields of a new study with default
2718 values. Dataverse administrators may clone a Network template and modify
2719 it for users of that dataverse. You may also change the input level of
2720 any field to make a certain field required, recommended, optional,
2721 hidden or disabled. Hidden fields will not be available to the user, but
2722 will be available to the dataverse administrator for update in cloned
2723 templates. Disabled field will not be available to the dataverse
2724 administrator for update. You may also add your own custom fields. When
2725 a user adds a new study, that user can select a template to fill in the
2726 defaults.</p>
2727 <p>To manage study templates, navigate to the Manage Study Templates table:</p>
2728 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Templates</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Manage</span> <span class="pre">Study</span> <span class="pre">Templates</span> <span class="pre">table</span></tt></p>
2729 <p><strong>Create Template</strong></p>
2730 <p>Study templates help to reduce the work needed to add a study, and to
2731 apply consistency to studies across a dataverse network. For example,
2732 you can create a template to include the Distributor and Contact details
2733 so that every study has the same values for that metadata.</p>
2734 <p>To create a new study template:</p>
2735 <ol class="arabic simple">
2736 <li>Click Create New Network Template.</li>
2737 <li>You see the Study Template page.</li>
2738 <li>In the Template Name field, enter a descriptive name for this
2739 template.</li>
2740 <li>Enter generic information in any of the Cataloging Information
2741 metadata fields. You can also add your own custom fields to the Data
2742 Collection/Methodology section of the template. Each custom field
2743 must be assigned a Name, Description and Field Type. You may also
2744 apply controlled vocabulary to any of the custom fields that are set
2745 to Plain Text Input as Field Type.</li>
2746 <li>After you complete entry of generic details in the fields that you
2747 choose to prepopulate for new studies, click Save to create the
2748 template.</li>
2749 </ol>
2750 <p><strong>Enable a template</strong></p>
2751 <p>Click the Enabled link for the given template. Enabled templates are
2752 available to database administrators for cloning and end users for
2753 creating studies.</p>
2754 <p><strong>Edit Template</strong></p>
2755 <p>To edit an existing study template:</p>
2756 <ol class="arabic simple">
2757 <li>In the list of templates, click the Edit link for the template that
2758 you choose to edit.</li>
2759 <li>You see the Study Template page, with the template setup that you
2760 selected.</li>
2761 <li>Edit the template fields that you choose to change, add, or remove.</li>
2762 </ol>
2763 <p><strong>Make a Template the Default</strong></p>
2764 <p>To set any study template as the default template that applies
2765 automatically to the creation of new network templates:</p>
2766 <p>In the list of templates, click the Make Default Selection link next to the name
2767 of the template that you choose to set as the default for a subnetwork(s). A pop-up window with the names of the subnetworks will appear and you may select the appropriate subnetworks. The subnetwork name(s) is displayed in the Default column of the template that you set as the
2768 default for each given subnetwork.</p>
2769 <p><strong>Remove Template</strong></p>
2770 <p>To delete a study template from a dataverse:</p>
2771 <ol class="arabic simple">
2772 <li>In the list of templates, click the Delete link for the template that
2773 you choose to remove from the network.</li>
2774 <li>You see the Delete Template page.</li>
2775 <li>Click Delete to remove the template from the network. Note that you
2776 cannot delete any template that is in use or is a default template at
2777 the network or dataverse level.</li>
2778 </ol>
2779 </div>
2780 </div>
2781 <div class="section" id="harvesting-section">
2782 <h3>Harvesting Section<a class="headerlink" href="#harvesting-section" title="Permalink to this headline">¶</a></h3>
2783 <div class="section" id="create-a-new-harvesting-dataverse">
2784 <h4>Create a New Harvesting Dataverse<a class="headerlink" href="#create-a-new-harvesting-dataverse" title="Permalink to this headline">¶</a></h4>
2785 <p>A harvesting dataverse allows studies from another site to be imported
2786 so they appear to be local, though data files remain on the remote site.
2787 This makes it possible to access content from data repositories and
2788 other sites with interesting content as long as they support the OAI or
2789 Nesstar protocols.</p>
2790 <p>Harvesting dataverses differ from ordinary dataverses in that study
2791 content cannot be edited since it is provided by a remote source. Most
2792 dataverse functions still apply including editing the dataverse name,
2793 branding, and setting permissions.</p>
2794 <p>Aside from providing the usual name, alias, and affiliation information,
2795 Creating a harvesting dataverse involves specifying the harvest
2796 protocol, OAI or Nesstar, the remote server URL, possibly format and set
2797 information, whether or how to register incoming studies, an optional
2798 harvest schedule, and permissions settings.</p>
2799 <p>To create a harvesting dataverse navigate to the Create a New Harvesting
2800 Dataverse page:</p>
2801 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;&nbsp;Harvesting</span> <span class="pre">tab</span> <span class="pre">&gt;&nbsp;Harvesting</span> <span class="pre">Dataverses</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">&quot;Create</span> <span class="pre">Harvesting</span> <span class="pre">Dataverse&quot;</span> <span class="pre">link</span></tt></p>
2802 <p>Complete the form by entering required information and click Save.</p>
2803 <p>An example dataverse to harvest studies native to the Harvard dataverse:</p>
2804 <ul class="simple">
2805 <li><strong>Harvesting Type:</strong> OAI Server</li>
2806 <li><strong>Dataverse Name:</strong> Test IQSS Harvest</li>
2807 <li><strong>Dataverse Alias:</strong> testiqss</li>
2808 <li><strong>Dataverse Affiliation:</strong> Our Organization</li>
2809 <li><strong>Server URL:</strong> <a class="reference external" href="http://dvn.iq.harvard.edu/dvn/OAIHandler">http://dvn.iq.harvard.edu/dvn/OAIHandler</a></li>
2810 <li><strong>Harvesting Set:</strong> No Set (harvest all)</li>
2811 <li><strong>Harvesting Format:</strong> DDI</li>
2812 <li><strong>Handle Registration:</strong> Do not register harvested studies (studies must already have a handle)</li>
2813 </ul>
2814 </div>
2815 <div class="section" id="manage-harvesting">
2816 <h4>Manage Harvesting<a class="headerlink" href="#manage-harvesting" title="Permalink to this headline">¶</a></h4>
2817 <p>Harvesting is a background process meaning once initiated, either
2818 directly or via a timer, it conducts a transaction with a remote server
2819 and exists without user intervention. Depending on site policy and
2820 considering the update frequency of remote content this could happen
2821 daily, weekly, or on-demand. How does one determine what happened? By
2822 using the Manage Harvesting Dataverses table on the Options page.</p>
2823 <p>To manage harvesting dataverses, navigate to the <strong>Manage Harvesting
2824 Dataverses</strong> table:</p>
2825 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Harvesting</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Harvesting</span> <span class="pre">Dataverses</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Manage</span> <span class="pre">Harvesting</span> <span class="pre">Dataverses</span> <span class="pre">table</span></tt></p>
2826 <p>The Manage Harvesting table displays all harvesting dataverses, their
2827 schedules, and harvest results in table form. The name of each
2828 harvesting dataverse is a link to that harvesting dataverse&#8217;s
2829 configuration page. The schedule, if configured, is displayed along with
2830 a button to enable or disable the schedule. The last attempt and result
2831 is displayed along with the last non-zero result. It is possible for the
2832 harvest to check for updates and there are none. A Run Now button
2833 provides on-demand harvesting and a Remove link deletes the harvesting
2834 dataverse.</p>
2835 <p>Note: the first time a dataverse is harvested the entire catalog is
2836 harvested. This may take some time to complete depending on size.
2837 Subsequent harvests check for additions and changes or updates.</p>
2838 <p>Harvest failures can be investigated by examining the import and server
2839 logs for the timeframe and dataverse in question.</p>
2840 </div>
2841 <div class="section" id="schedule-study-exports">
2842 <h4>Schedule Study Exports<a class="headerlink" href="#schedule-study-exports" title="Permalink to this headline">¶</a></h4>
2843 <p>Sharing studies programmatically or in batch such as by harvesting
2844 requires information about the study or metadata to be exported in a
2845 commonly understood format. As this is a background process requiring no
2846 user intervention, it is common practice to schedule this to capture
2847 updated information.</p>
2848 <p>Our export process generates DDI, Dublin Core, Marc, and FGDC formats
2849 though DDI and Dublin Core are most commonly used. Be aware that
2850 different formats contain different amounts of information with DDI
2851 being most complete because it is our native format.</p>
2852 <p>To schedule study exports, navigate to the Harvesting Settings subtab:</p>
2853 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Harvesting</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Export</span> <span class="pre">Schedule</span></tt></p>
2854 <p>First enable export then choose frequency: daily using hour of day or
2855 weekly using day of week. Click Save and you are finished.</p>
2856 <p>To disable, just choose Disable export and Save.</p>
2857 </div>
2858 <div class="section" id="manage-oai-harvesting-sets">
2859 <h4>Manage OAI Harvesting Sets<a class="headerlink" href="#manage-oai-harvesting-sets" title="Permalink to this headline">¶</a></h4>
2860 <p>By default, a client harvesting from the Dataverse Network that does not
2861 specify a set would fetch all unrestricted, locally owned
2862 studies - in other words public studies that were not harvested
2863 from elsewhere. For various reasons it might be desirable to define sets
2864 of studies for harvest such as by owner, or to include a set that was
2865 harvested from elsewhere. This is accomplished using the Manage OAI
2866 Harvesting Sets table on the Options page.</p>
2867 <p>The Manage OAI Harvesting Sets table lists all currently defined OAI
2868 sets, their specifications, and edit, create, and delete functionality.</p>
2869 <p>To manage OAI harvesting sets, navigate to the&nbsp;Manage OAI Harvesting
2870 Sets table:</p>
2871 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Harvesting</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">OAI</span> <span class="pre">Harvesting</span> <span class="pre">Sets</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Manage&nbsp;OAI</span> <span class="pre">Harvesting</span> <span class="pre">Sets</span> <span class="pre">table</span></tt></p>
2872 <p>To create an OAI set, click Create OAI Harvesting Set, complete the
2873 required fields and Save. The essential parameter that defines the set
2874 is the Query Definition. This is a search query using <a class="reference external" href="http://lucene.apache.org/java/3_0_0/queryparsersyntax.html">Lucene
2875 syntax</a>
2876 whose results populate the set.</p>
2877 <p>Once created, a set can later be edited by clicking on its name.</p>
2878 <p>To delete a set, click the appropriately named Delete Set link.</p>
2879 <p>To test the query results before creating an OAI set, a recommended
2880 approach is to create a <a class="reference internal" href="#manage-collections"><em>dynamic study
2881 collection</em></a> using the
2882 proposed query and view the collection contents. Both features use the
2883 same <a class="reference external" href="http://lucene.apache.org/java/3_0_0/queryparsersyntax.html">Lucene
2884 syntax</a>
2885 but a study collection provides a convenient way to confirm the results.</p>
2886 <p>Generally speaking, basic queries take the form of study metadata
2887 field:value. Examples include:</p>
2888 <ul class="simple">
2889 <li><tt class="docutils literal"><span class="pre">globalId:&quot;hdl</span> <span class="pre">1902</span> <span class="pre">1</span> <span class="pre">10684&quot;</span> <span class="pre">OR</span> <span class="pre">globalId:&quot;hdl</span> <span class="pre">1902</span> <span class="pre">1</span> <span class="pre">11155&quot;</span></tt>: Include studies with global ids <a class="reference external" href="hdl:1902.1/10684">hdl:1902.1/10684</a> and
2890 <a class="reference external" href="hdl:1902.1/11155">hdl:1902.1/11155</a></li>
2891 <li><tt class="docutils literal"><span class="pre">authority:1902.2</span></tt>: Include studies whose authority is 1902.2. Different authorities usually represent different sources such
2892 as IQSS, ICPSR, etc.</li>
2893 <li><tt class="docutils literal"><span class="pre">dvOwnerId:184</span></tt>: Include all studies belonging to dataverse with database id 184</li>
2894 <li><tt class="docutils literal"><span class="pre">studyNoteType:&quot;DATAPASS&quot;</span></tt>: Include all studies that were tagged with or include the text DATAPASS in their study note field.</li>
2895 </ul>
2896 <p><strong>Study Metadata Search Terms:</strong></p>
2897 <div class="line-block">
2898 <div class="line">title</div>
2899 <div class="line">subtitle</div>
2900 <div class="line">studyId</div>
2901 <div class="line">otherId</div>
2902 <div class="line">authorName</div>
2903 <div class="line">authorAffiliation</div>
2904 <div class="line">producerName</div>
2905 <div class="line">productionDate</div>
2906 <div class="line">fundingAgency</div>
2907 <div class="line">distributorName</div>
2908 <div class="line">distributorContact</div>
2909 <div class="line">distributorContactAffiliation</div>
2910 <div class="line">distributorContactEmail</div>
2911 <div class="line">distributionDate</div>
2912 <div class="line">depositor</div>
2913 <div class="line">dateOfDeposit</div>
2914 <div class="line">seriesName</div>
2915 <div class="line">seriesInformation</div>
2916 <div class="line">studyVersion</div>
2917 <div class="line">relatedPublications</div>
2918 <div class="line">relatedMaterial</div>
2919 <div class="line">relatedStudy</div>
2920 <div class="line">otherReferences</div>
2921 <div class="line">keywordValue</div>
2922 <div class="line">keywordVocabulary</div>
2923 <div class="line">topicClassValue</div>
2924 <div class="line">topicClassVocabulary</div>
2925 <div class="line">abstractText</div>
2926 <div class="line">abstractDate</div>
2927 <div class="line">timePeriodCoveredStart</div>
2928 <div class="line">timePeriodCoveredEnd</div>
2929 <div class="line">dateOfCollection</div>
2930 <div class="line">dateOfCollectionEnd</div>
2931 <div class="line">country</div>
2932 <div class="line">geographicCoverage</div>
2933 <div class="line">geographicUnit</div>
2934 <div class="line">unitOfAnalysis</div>
2935 <div class="line">universe</div>
2936 <div class="line">kindOfData</div>
2937 <div class="line">timeMethod</div>
2938 <div class="line">dataCollector</div>
2939 <div class="line">frequencyOfDataCollection</div>
2940 <div class="line">samplingProcedure</div>
2941 <div class="line">deviationsFromSampleDesign</div>
2942 <div class="line">collectionMode</div>
2943 <div class="line">researchInstrument</div>
2944 <div class="line">dataSources</div>
2945 <div class="line">originOfSources</div>
2946 <div class="line">characteristicOfSources</div>
2947 <div class="line">accessToSources</div>
2948 <div class="line">dataCollectionSituation</div>
2949 <div class="line">actionsToMinimizeLoss</div>
2950 <div class="line">controlOperations</div>
2951 <div class="line">weighting</div>
2952 <div class="line">cleaningOperations</div>
2953 <div class="line">studyLevelErrorNotes</div>
2954 <div class="line">responseRate</div>
2955 <div class="line">samplingErrorEstimate</div>
2956 <div class="line">otherDataAppraisal</div>
2957 <div class="line">placeOfAccess</div>
2958 <div class="line">originalArchive</div>
2959 <div class="line">availabilityStatus</div>
2960 <div class="line">collectionSize</div>
2961 <div class="line">studyCompletion</div>
2962 <div class="line">confidentialityDeclaration</div>
2963 <div class="line">specialPermissions</div>
2964 <div class="line">restrictions</div>
2965 <div class="line">contact</div>
2966 <div class="line">citationRequirements</div>
2967 <div class="line">depositorRequirements</div>
2968 <div class="line">conditions</div>
2969 <div class="line">disclaimer</div>
2970 <div class="line">studyNoteType</div>
2971 <div class="line">studyNoteSubject</div>
2972 <div class="line">studyNoteText</div>
2973 </div>
2974 </div>
2975 <div class="section" id="edit-lockss-harvest-settings">
2976 <span id="id9"></span><h4>Edit LOCKSS Harvest Settings<a class="headerlink" href="#edit-lockss-harvest-settings" title="Permalink to this headline">¶</a></h4>
2977 <p><strong>Summary:</strong></p>
2978 <p><a class="reference external" href="http://lockss.stanford.edu/lockss/Home">LOCKSS Project</a> or <em>Lots
2979 of Copies Keeps Stuff Safe</em> is an international initiative based at
2980 Stanford University Libraries that provides a way to inexpensively
2981 collect and preserve copies of authorized e-content. It does so using an
2982 open source, peer-to-peer, decentralized server infrastructure. In order
2983 to make a LOCKSS server crawl, collect and preserve content from a Dataverse Network,
2984 both the server (the LOCKSS daemon) and the client (the Dataverse Network) sides must
2985 be properly configured. In simple terms, the LOCKSS server needs to be
2986 pointed at the Dataverse Network, given its location and instructions on what to
2987 crawl; the Dataverse Network needs to be configured to allow the LOCKSS daemon to
2988 access the data. The section below describes the configuration tasks
2989 that the Dataverse Network administrator will need to do on the client side. It does
2990 not describe how LOCKSS works and what it does in general; it&#8217;s a fairly
2991 complex system, so please refer to the documentation on the <a class="reference external" href="http://lockss.stanford.edu/lockss/Home">LOCKSS Project</a> site for more
2992 information. Some information intended to a LOCKSS server administrator
2993 is available in the <a class="reference external" href="http://guides.thedata.org/book/h-using-lockss-dvn">&#8220;Using LOCKSS with Dataverse Network (DVN)&#8221;</a> of the
2994 <a class="reference external" href="http://guides.thedata.org/book/installers-guides">Dataverse Network Installers Guide</a></p>
2995 <blockquote>
2996 <div>(our primary sysadmin-level manual).</div></blockquote>
2997 <p><strong>Configuration Tasks:</strong></p>
2998 <p>Note that neither the standard LOCKSS Web Crawler, nor the OAI plugin
2999 can properly harvest materials from a Dataverse Network.&nbsp; A custom LOCKSS plugin
3000 developed and maintained by the Dataverse Network project is available here:
3001 <a class="reference external" href="http://lockss.hmdc.harvard.edu/lockss/plugin/DVNOAIPlugin.jar">http://lockss.hmdc.harvard.edu/lockss/plugin/DVNOAIPlugin.jar</a>.
3002 For more information on the plugin, please see the <a class="reference external" href="http://guides.thedata.org/book/h-using-lockss-dvn">&#8220;Using LOCKSS with
3003 Dataverse Network (DVN)&#8221;</a> section of
3004 the Dataverse Network Installers Guide. In order for a LOCKSS daemon to collect DVN
3005 content designated for preservation, an Archival Unit must be created
3006 with the plugin above. On the Dataverse Network side, a Manifest must be created that
3007 gives the LOCKSS daemon permission to collect the data. This is done by
3008 completing the &#8220;LOCKSS Settings&#8221; section of the:
3009 <tt class="docutils literal"><span class="pre">Network</span> <span class="pre">Options</span> <span class="pre">-&gt;</span> <span class="pre">Harvesting</span> <span class="pre">-&gt;</span> <span class="pre">Settings</span> <span class="pre">tab.</span></tt></p>
3010 <p>For the Dataverse Network, LOCKSS can be configured at the network level
3011 for the entire site and also locally at the dataverse level. The network
3012 level enables LOCKSS harvesting but more restrictive policies, including
3013 disabling harvesting, can be configured by each dataverse. A dataverse
3014 cannot enable LOCKSS harvesting if it has not first been enabled at the
3015 network level.</p>
3016 <p>This &#8220;Edit LOCKSS Harvest Settings&#8221; section refers to the network level
3017 LOCKSS configuration.</p>
3018 <p>To enable LOCKSS harvesting at the network level do the following:</p>
3019 <ul class="simple">
3020 <li>Navigate to the LOCKSS Settings page: <tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">-&gt;</span> <span class="pre">Network</span> <span class="pre">Options</span> <span class="pre">-&gt;</span> <span class="pre">Harvesting</span> <span class="pre">-&gt;</span> <span class="pre">Settings</span></tt>.</li>
3021 <li>Fill in the harvest information including the level of harvesting allowed (Harvesting Type, Restricted Data Files), the scope
3022 of harvest by choosing a predefined OAI set, then if necessary a list of servers or domains allowed to harvest.</li>
3023 <li>It&#8217;s important to understand that when a LOCKSS daemon is authorized
3024 to &#8220;crawl restricted files&#8221;, this does not by itself grant the actual
3025 access to the materials! This setting only specifies that the daemon
3026 should not be skipping such restricted materials outright. (The idea
3027 behind this is that in an archive with large amounts of
3028 access-restricted materials, if only public materials are to be
3029 preserved by LOCKSS, lots of crawling time can be saved by instructing
3030 the daemon to skip non-public files, instead of having it try to access
3031 them and get 403/Permission Denied). If it is indeed desired to have
3032 non-public materials collected and preserved by LOCKSS, it is the
3033 responsibility of the DVN Administrator to give the LOCKSS daemon
3034 permission to access the files. As of DVN version 3.3, this can only be
3035 done based on the IP address of the LOCKSS server (by creating an
3036 IP-based user group with the appropriate permissions).</li>
3037 <li>Next select any licensing options or enter additional terms, and click &#8220;Save Changes&#8221;.</li>
3038 <li>Once LOCKSS harvesting has been enabled, the LOCKSS Manifest page will
3039 be provided by the application. This manifest is read by LOCKSS servers
3040 and constitutes agreement to the specified terms. The URL for the
3041 network-level LOCKSS manifest is
3042 <tt class="docutils literal"><span class="pre">http</span></tt><tt class="docutils literal"><span class="pre">://&lt;YOUR</span> <span class="pre">SERVER&gt;/dvn/faces/ManifestPage.xhtml</span></tt> (it will be
3043 needed by the LOCKSS server administrator in order to configure an
3044 <em>Archive Unit</em> for crawling and preserving the DVN).</li>
3045 </ul>
3046 </div>
3047 </div>
3048 <div class="section" id="settings-section">
3049 <h3>Settings Section<a class="headerlink" href="#settings-section" title="Permalink to this headline">¶</a></h3>
3050 <div class="section" id="edit-name">
3051 <h4>Edit Name<a class="headerlink" href="#edit-name" title="Permalink to this headline">¶</a></h4>
3052 <p>The name of your Dataverse Network installation is displayed at the top
3053 of the Network homepage, and as a link at the top of each dataverse
3054 homepage in your Network.</p>
3055 <p>To create or change the name of your Network, navigate to the Settings
3056 tab on the Options page:</p>
3057 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">General</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Network</span> <span class="pre">Name</span></tt></p>
3058 <p>Enter a descriptive title for your Network. There are no naming
3059 restrictions, but it appears in the heading of every dataverse in your
3060 Network, so a short name works best.</p>
3061 <p>Click Save and you are done!</p>
3062 </div>
3063 <div class="section" id="id10">
3064 <h4>Edit Layout Branding<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h4>
3065 <p>When you install a Network, there is no banner or footer on any page in
3066 the Network. You can apply any style to the Network pages, such as that
3067 used on your organization&#8217;s website. You can use plain text, HTML,
3068 JavaScript, and style tags to define your custom banner and footer. If
3069 your website has such elements as a navigation menu or images, you can
3070 add them to your Network pages.</p>
3071 <p>To customize the layout branding of your Network, navigate to the
3072 Customization subtab on the Options page:</p>
3073 <p>Network home page &gt; Options page &gt; Settings tab &gt; Customization subtab &gt;
3074 Edit Layout Branding</p>
3075 <p>Enter your banner and footer content in the Custom Banner and Custom
3076 Footer fields and Save.</p>
3077 <p>See <a class="reference internal" href="#edit-layout-branding"><em>Layout Branding Tips</em></a> for guidelines.</p>
3078 </div>
3079 <div class="section" id="id11">
3080 <h4>Edit Description<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h4>
3081 <p>By default your Network homepage has the following description:
3082 <tt class="docutils literal"><span class="pre">A</span> <span class="pre">description</span> <span class="pre">of</span> <span class="pre">your</span> <span class="pre">Dataverse</span> <span class="pre">Network</span> <span class="pre">or</span> <span class="pre">announcements</span> <span class="pre">may</span> <span class="pre">be</span> <span class="pre">added</span> <span class="pre">here.</span> <span class="pre">Use</span> <span class="pre">Network</span> <span class="pre">Options</span> <span class="pre">to</span> <span class="pre">edit</span> <span class="pre">or</span> <span class="pre">remove</span> <span class="pre">this</span> <span class="pre">text.</span></tt>
3083 You can edit that text to describe or announce such things as new
3084 Network features, new dataverses, or maintenance activities. You also
3085 can disable the description to not appear on the homepage.</p>
3086 <p>To manage the Network description, navigate to:</p>
3087 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">General</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Network</span> <span class="pre">Description</span></tt></p>
3088 <p>Create a description by entering your desired content in the text box.
3089 HTML, JavaScript, and style tags are permitted. The <tt class="docutils literal"><span class="pre">html</span></tt> and
3090 <tt class="docutils literal"><span class="pre">body</span></tt> element types are not allowed. Next enable the description
3091 display by checking the Enable Description in Homepage checkbox. Click
3092 Save and you&#8217;re done. You can disable the display of the description but
3093 keep the content by unchecking and saving.</p>
3094 </div>
3095 <div class="section" id="edit-dataverse-requirements">
3096 <h4>Edit Dataverse Requirements<a class="headerlink" href="#edit-dataverse-requirements" title="Permalink to this headline">¶</a></h4>
3097 <p>Enforcing a minimum set of requirements can help ensure content
3098 consistency.</p>
3099 <p>When you enable dataverse requirements, newly created dataverses cannot
3100 be made public or released until the selected requirements are met.
3101 Existing dataverses are not affected until they are edited. Edits to
3102 existing dataverses cannot be saved until requirements are met.</p>
3103 <p>To manage the requirements, navigate to:</p>
3104 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Advanced</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Release</span> <span class="pre">Dataverse</span> <span class="pre">Requirements</span></tt></p>
3105 <p>Available requirements include:</p>
3106 <ul class="simple">
3107 <li>Require Network Homepage Dataverse Description</li>
3108 <li>Require Dataverse Affiliation</li>
3109 <li>Require Dataverse Classification</li>
3110 <li>Require Dataverse Studies included prior to release</li>
3111 </ul>
3112 </div>
3113 <div class="section" id="id12">
3114 <h4>Manage E-Mail Notifications<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h4>
3115 <p>The Dataverse Network sends notifications via email for a number of
3116 events on the site, including workflow events such as creating a
3117 dataverse, uploading files, releasing a study, etc. Many of these
3118 notifications are sent to the user initiating the action as well as to
3119 the network administrator. Additionally, the Report Issue link on the
3120 network home page sends email to the network administrator. By default,
3121 this email is sent to
3122 <cite>support&#64;thedata.org &lt;mailto:support&#64;thedata.org&gt;</cite>.</p>
3123 <p>To change this email address navigate to the Options page:</p>
3124 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">General</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">E-Mail</span> <span class="pre">Address(es)</span></tt></p>
3125 <p>Enter the address of network administrators who should receive these
3126 notifications and Save.</p>
3127 <p>Please note the Report Issue link when accessed within a dataverse gives
3128 the option of sending notification to the network or dataverse
3129 administrator. Configuring the dataverse administrator address is done
3130 at the dataverse level:
3131 <tt class="docutils literal"><span class="pre">(Your)</span> <span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">General</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">E-Mail</span> <span class="pre">Address(es)</span></tt></p>
3132 </div>
3133 <div class="section" id="id13">
3134 <h4>Enable Twitter<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h4>
3135 <p>If your Dataverse Network has been configured for Automatic Tweeting,
3136 you will see an option listed as &#8220;Enable Twitter.&#8221; When you click this,
3137 you will be redirected to Twitter to authorize the Dataverse Network
3138 application to send tweets for you.</p>
3139 <p>To manage the Dataverse Twitter configuration, navigate to:</p>
3140 <p><tt class="docutils literal"><span class="pre">Dataverse</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Settings</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Promote</span> <span class="pre">Your</span> <span class="pre">Dataverse</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Sync</span> <span class="pre">Dataverse</span> <span class="pre">With</span> <span class="pre">Twitter</span></tt></p>
3141 <p>Once authorized, tweets will be sent for each new dataverse that is
3142 released.</p>
3143 <p>To disable Automatic Tweeting, go to the options page, and click
3144 &#8220;Disable Twitter.&#8221;</p>
3145 </div>
3146 </div>
3147 <div class="section" id="terms-section">
3148 <h3>Terms Section<a class="headerlink" href="#terms-section" title="Permalink to this headline">¶</a></h3>
3149 <div class="section" id="edit-terms-for-account-creation">
3150 <h4>Edit Terms for Account Creation<a class="headerlink" href="#edit-terms-for-account-creation" title="Permalink to this headline">¶</a></h4>
3151 <p>You can set up Terms of Use that require users with new accounts to
3152 accept your terms before logging in for the first time.</p>
3153 <p>To configure these terms navigate to the Options page:</p>
3154 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Terms</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Account</span> <span class="pre">Term</span> <span class="pre">of</span> <span class="pre">Use</span></tt></p>
3155 <p>Enter your required terms as you would like them to appear to users.
3156 HTML, JavaScript, and style tags are permitted. The <tt class="docutils literal"><span class="pre">html</span></tt> and
3157 <tt class="docutils literal"><span class="pre">body</span></tt> element types are not allowed. Check Enable Terms of Use to
3158 display these terms. Click Save and you are finished. To disable but
3159 preserve your current terms, uncheck the Enable checkbox and save.</p>
3160 </div>
3161 <div class="section" id="id14">
3162 <h4>Edit Terms for Study Creation<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h4>
3163 <p>You can set up Terms of Use for the Network that require users to accept
3164 your terms before they can create or modify studies, including adding
3165 data files. These terms are defined at the network level so they apply
3166 across all dataverses. Users will be presented with these terms the
3167 first time they attempt to modify or create a study during each session.</p>
3168 <p>To configure these terms of use navigate to the Options page:</p>
3169 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Terms</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Deposit</span> <span class="pre">Term</span> <span class="pre">of</span> <span class="pre">Use</span></tt></p>
3170 <p>Enter your terms as you would like to display them to the user. HTML,
3171 JavaScript, and style tags are permitted. The <tt class="docutils literal"><span class="pre">html</span></tt> and <tt class="docutils literal"><span class="pre">body</span></tt>
3172 element types are not allowed. Check Enable Terms of Use and save.
3173 Uncheck Enable Terms of Use and save to disable but preserve existing
3174 terms of use.</p>
3175 </div>
3176 <div class="section" id="id15">
3177 <h4>Edit Terms for File Download<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h4>
3178 <p>You can set up Terms of Use for the Network that require users to accept
3179 your terms before they can download or subset files from the Network.
3180 Since this is defined at the network level it applies to all dataverses.
3181 Users will be presented with these terms the first time they attempt to
3182 download a file or access the subsetting and analysis page each session.</p>
3183 <p>To configure these terms, navigate to the Options page:</p>
3184 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Terms</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Download</span> <span class="pre">Term</span> <span class="pre">of</span> <span class="pre">Use</span></tt></p>
3185 <p>Enter the terms as you want them to appear to the user. HTML,
3186 JavaScript, and style tags are permitted. The <tt class="docutils literal"><span class="pre">html</span></tt> and <tt class="docutils literal"><span class="pre">body</span></tt>
3187 element types are not allowed. Check Enable Terms of Use and save.
3188 Unchecking the checkbox and saving disables the display of the terms but
3189 preserves the current content.</p>
3190 </div>
3191 <div class="section" id="id16">
3192 <h4>Download Tracking Data<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h4>
3193 <p>You can view any guestbook responses that have been made in all
3194 dataverses. Beginning with version 3.2 of Dataverse Network, for any
3195 dataverse where the guestbook is not enabled data will be collected
3196 silently based on the logged in user or anonymously. The data displayed
3197 includes user account data or the session id of an anonymous user, the
3198 global ID, study title and filename of the file downloaded, the time of
3199 the download, the type of download and any custom questions that have
3200 been answered. The username/session ID and download type were not
3201 collected in the 3.1 version of DVN. A comma separated values file of
3202 all download tracking data may be downloaded by clicking the Export
3203 Results button.</p>
3204 <p>To manage the Network download tracking data, navigate to:</p>
3205 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Download</span> <span class="pre">Tracking</span> <span class="pre">Data</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Manage</span> <span class="pre">Download</span> <span class="pre">Tracking</span> <span class="pre">Data</span> <span class="pre">table</span></tt></p>
3206 </div>
3207 </div>
3208 <div class="section" id="permissions-and-users-section">
3209 <h3>Permissions and Users Section<a class="headerlink" href="#permissions-and-users-section" title="Permalink to this headline">¶</a></h3>
3210 <div class="section" id="manage-network-permissions">
3211 <h4>Manage Network Permissions<a class="headerlink" href="#manage-network-permissions" title="Permalink to this headline">¶</a></h4>
3212 <p>Permissions that are configured at the network level include:</p>
3213 <ul class="simple">
3214 <li>Enabling users to create an account when they create a dataverse.</li>
3215 <li>Granting privileged roles to existing users including network
3216 administrator and dataverse creator.</li>
3217 <li>Changing and revoking privileged roles of existing users.</li>
3218 </ul>
3219 <p>Enabling users to create an account when they create a dataverse
3220 displays a &#8220;Create a Dataverse&#8221; link on the network home page. New and
3221 unregistered users coming to the site can click on this link, create an
3222 account and a dataverse in one workflow rather than taking two separate
3223 steps involving the network administrator.</p>
3224 <p>Granting a user account network administrator status gives that user
3225 full control over the application as managed through the UI.</p>
3226 <p>Granting a user account dataverse creator status is somewhat a legacy
3227 function since any user who creates a dataverse has this role.</p>
3228 <p>To manage these permissions, navigate to the Manage Network Permissions
3229 table on the Options page:</p>
3230 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Manage</span> <span class="pre">Network</span> <span class="pre">Permissions</span> <span class="pre">table</span></tt></p>
3231 <p>Enable account with dataverse creation by checking that option and
3232 saving.</p>
3233 <p>Granting privileged status to a user requires entering a valid, existing
3234 user name, clicking add, choosing the role, then saving changes.</p>
3235 </div>
3236 <div class="section" id="roles-by-version-state-table">
3237 <h4>Roles by Version State Table<a class="headerlink" href="#roles-by-version-state-table" title="Permalink to this headline">¶</a></h4>
3238 <table border="1" class="docutils">
3239 <colgroup>
3240 <col width="20%" />
3241 <col width="11%" />
3242 <col width="15%" />
3243 <col width="3%" />
3244 <col width="13%" />
3245 <col width="17%" />
3246 <col width="20%" />
3247 </colgroup>
3248 <thead valign="bottom">
3249 <tr class="row-odd"><th class="head">&nbsp;</th>
3250 <th class="head"><strong>Role</strong></th>
3251 <th class="head">&nbsp;</th>
3252 <th class="head" colspan="2">&nbsp;</th>
3253 <th class="head">&nbsp;</th>
3254 <th class="head">&nbsp;</th>
3255 </tr>
3256 </thead>
3257 <tbody valign="top">
3258 <tr class="row-even"><td><strong>Version State</strong></td>
3259 <td>None</td>
3260 <td>Contributor +,
3261 ++</td>
3262 <td colspan="2">Curator</td>
3263 <td>Admin</td>
3264 <td>Network Admin**</td>
3265 </tr>
3266 <tr class="row-odd"><td>Draft</td>
3267 <td>&nbsp;</td>
3268 <td>E,E2,D3,S,V</td>
3269 <td colspan="2">E,E2,P,T,D3,R,V</td>
3270 <td>E,E2,P,T,D3,R,V</td>
3271 <td>E,E2,P,T,D3,D2,R,V</td>
3272 </tr>
3273 <tr class="row-even"><td>In Review</td>
3274 <td>&nbsp;</td>
3275 <td>E,E2,D3,V</td>
3276 <td colspan="2">E,E2,P,T,D3,R,V</td>
3277 <td>E,E2,P,T,D3,R,V</td>
3278 <td>E,E2,P,T,D3,R,D2,V</td>
3279 </tr>
3280 <tr class="row-odd"><td>Released</td>
3281 <td>V</td>
3282 <td>E,V</td>
3283 <td colspan="2">E,P,T,D1,V</td>
3284 <td>E,P,T,D1,V</td>
3285 <td>E,P,T,D2,D1,V</td>
3286 </tr>
3287 <tr class="row-even"><td>Archived</td>
3288 <td>V</td>
3289 <td>V</td>
3290 <td colspan="2">P,T,V</td>
3291 <td>P,T,V</td>
3292 <td>P,T,D2,V</td>
3293 </tr>
3294 <tr class="row-odd"><td>Deaccessioned</td>
3295 <td>&nbsp;</td>
3296 <td>&nbsp;</td>
3297 <td colspan="2">P,T,R2,V</td>
3298 <td>P,T,R2,V</td>
3299 <td>P,T,R2,D2,V</td>
3300 </tr>
3301 </tbody>
3302 </table>
3303 <p><strong>Legend:</strong></p>
3304 <p>E = Edit (Cataloging info, File meta data, Add files)</p>
3305 <p>E2 = Edit Study Version Notes</p>
3306 <p>D1 = Deaccession</p>
3307 <p>P = Permission</p>
3308 <p>T = Create Template</p>
3309 <p>D2 = Destroy</p>
3310 <p>D3 = Delete Draft, Delete Review Version</p>
3311 <p>S = Submit for Review</p>
3312 <p>R = Release</p>
3313 <p>R2 = Restore</p>
3314 <p>V = View</p>
3315 <p><strong>Notes:</strong></p>
3316 <p><a href="#id17"><span class="problematic" id="id18">*</span></a>Same as Curator</p>
3317 <p><a href="#id19"><span class="problematic" id="id20">**</span></a>Same as Curator + D2</p>
3318 <p>+Contributor actions (E,D3,S,V) depend on new DV permission settings. A
3319 contributor role can act on their own studies (default) or all studies
3320 in a dv, and registered users can become contributors and act on their
3321 own studies or all studies in a dv.</p>
3322 <p>++ A contributor is defined either as a contributor role or as any
3323 registered user in a DV that allows all registered users to contribute.</p>
3324 </div>
3325 <div class="section" id="authorization-to-access-terms-protected-files-via-the-api">
3326 <h4>Authorization to access Terms-protected files via the API<a class="headerlink" href="#authorization-to-access-terms-protected-files-via-the-api" title="Permalink to this headline">¶</a></h4>
3327 <p>As of DVN v. 3.2, a programmatic API has been provided for accessing DVN
3328 materials. It supports Basic HTTP Auth where the client authenticates
3329 itself as an existing DVN (or anonymous) user. Based on this, the API
3330 determines whether the client has permission to access the requested
3331 files or metadata. It is important to remember however, that in addition
3332 to access permissions, DVN files may also be subject to &#8220;Terms of Use&#8221;
3333 agreements. When access to such files is attempted through the Web
3334 Download or Subsetting interfaces, the user is presented with an
3335 agreement form. The API however is intended for automated clients, so
3336 the remote party&#8217;s compliance with the Terms of Use must be established
3337 beforehand.&nbsp;<strong>We advise you to have a written agreement with authorized
3338 parties before allowing them to access data sets, bypassing the Terms of
3339 Use. The authorized party should be responsible for enforcing the Terms
3340 of Use to their end users.</strong>Once such an agreement has been
3341 established, you can grant the specified user unrestricted access to
3342 Terms-protected materials on the Network home page &gt; Options page &gt;
3343 PERMISSIONS tab &gt; Permissions subtab, in the &#8220;Authorize Users to bypass
3344 Terms of Use&#8221; section.</p>
3345 <p>Please consult the Data Sharing section of the Guide for additional
3346 information on the <a class="reference internal" href="dataverse-api-main.html#data-sharing-api"><em>Data Sharing API</em></a>.</p>
3347 </div>
3348 <div class="section" id="create-account">
3349 <h4>Create Account<a class="headerlink" href="#create-account" title="Permalink to this headline">¶</a></h4>
3350 <p>There are several ways to create accounts: at the network level by the
3351 network administrator, at the dataverse level by the dataverse
3352 administrator, and by the new user themselves if the option to create an
3353 account when creating a dataverse is enabled.</p>
3354 <p>Accounts created by all methods are equivalent with the exception of
3355 granting dataverse creator status during the create a dataverse
3356 workflow. That status can be granted afterwards by the network
3357 administrator if necessary.</p>
3358 <p>To create an account at the <strong>network admin level</strong>, navigate to the Create
3359 Account page from the Options page:</p>
3360 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Users</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Create</span> <span class="pre">User</span> <span class="pre">link</span> <span class="pre">&gt;</span> <span class="pre">Create</span> <span class="pre">Account</span> <span class="pre">page</span></tt></p>
3361 <p>Complete the required information denoted by the red asterisk and save.
3362 Note: an email address can also be used as a username.</p>
3363 </div>
3364 <div class="section" id="manage-users">
3365 <h4>Manage Users<a class="headerlink" href="#manage-users" title="Permalink to this headline">¶</a></h4>
3366 <p>The Manage Users table gives the network administrator a list of all
3367 user accounts in table form. It lists username, full name, roles
3368 including at which dataverse the role is granted, and the current status
3369 whether active or deactivated.</p>
3370 <p>Usernames are listed alphabetically and clicking on a username takes you
3371 to the account page that contains detailed information on that account.
3372 It also provides the ability to update personal details and change
3373 passwords.</p>
3374 <p>The Manage Users table also provides the ability to deactivate a user
3375 account.</p>
3376 <p>To view the Manage Users table navigate to the Options page:</p>
3377 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Users</span> <span class="pre">subtab</span> <span class="pre">&gt;</span> <span class="pre">Manage</span> <span class="pre">Users</span> <span class="pre">table</span></tt></p>
3378 </div>
3379 <div class="section" id="manage-groups">
3380 <h4>Manage Groups<a class="headerlink" href="#manage-groups" title="Permalink to this headline">¶</a></h4>
3381 <p>Groups in the Dataverse Network are a way to identify collections of
3382 users so permissions can be applied collectively rather than
3383 individually. This allows controlling permissions for individuals by
3384 altering membership in the group without affecting permissions of other
3385 members. Groups can be defined by user names or IP addresses.</p>
3386 <p>The Manage Groups table lists information about existing groups in table
3387 form including name, display or friendly name, and group membership.</p>
3388 <p>Clicking on the name takes you to the Edit Group page where the group&#8217;s
3389 configuration can be changed. It is also possible to create and delete
3390 groups from the Manage Groups table.</p>
3391 <p>To view the Manage Groups table, navigate to the Options page:</p>
3392 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Permissions</span> <span class="pre">tab</span> <span class="pre">&gt;</span> <span class="pre">Groups</span> <span class="pre">subtab</span> <span class="pre">&gt;</span>
3393 <span class="pre">Manage</span> <span class="pre">Groups</span> <span class="pre">table</span></tt></p>
3394 <p>Once on the Groups subtab, viewing the Manage Groups table, you can
3395 create or delete a group.</p>
3396 <p>When creating a group you must choose whether to identify users by
3397 username or by IP address with a Username Group or IP User Group.</p>
3398 <p>With a Username Group, enter an existing username into the edit box,
3399 click the &#8220;+&#8221; symbol to enter additional users, then save.</p>
3400 <p>With an IP User Group, enter an IP address or domain name into the edit
3401 box. Wildcards can be used by specifying an asterisk (*) in place of an
3402 IP address octet (eg. 10.20.30.*), or for the sub-domain or host
3403 portion of the domain name (eg. *.mydomain.edu).</p>
3404 <p>Last, an optional special feature of the IP User Group is to allow for
3405 an Affiliate Login Service. Effectively this allows for the use of a
3406 proxy to access the Dataverse Network on behalf of a group such as a
3407 University Library where identification and authorization of users is
3408 managed by their proxy service. To enable this feature, enter IP
3409 addresses of any proxy servers that will access Dataverse Network, check
3410 This IP group has an affiliate login service, enter the Affiliate Name
3411 as it will appear on the&nbsp;Dataverse Network Login page, and the Affiliate
3412 URL which would go to the proxy server. Save and you are finished.</p>
3413 </div>
3414 </div>
3415 <div class="section" id="utilities">
3416 <h3>Utilities<a class="headerlink" href="#utilities" title="Permalink to this headline">¶</a></h3>
3417 <p>The Dataverse Network provides the network administrator with tools to
3418 manually execute background processes, perform functions in batch, and
3419 resolve occasional operational issues.</p>
3420 <p>Navigate to the Utilities from the Options page:</p>
3421 <p><tt class="docutils literal"><span class="pre">Network</span> <span class="pre">home</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Options</span> <span class="pre">page</span> <span class="pre">&gt;</span> <span class="pre">Utilities</span> <span class="pre">tab</span></tt></p>
3422 <p>Available tools include:</p>
3423 <ul class="simple">
3424 <li><strong>Study Utilities</strong> - Create draft versions of studies, release file locks and delete multiple studies by inputting ID&#8217;s.</li>
3425 <li><strong>Index Utilities</strong> - Create a search index.</li>
3426 <li><strong>Export Utilities</strong> - Select files and export them.</li>
3427 <li><strong>Harvest Utilities</strong> - Harvest selected studies from another Network.</li>
3428 <li><strong>File Utilities</strong> - Select files and apply the JHOVE file validation process to them.</li>
3429 <li><strong>Import Utilities</strong> - Import multiple study files by using this custom batch process.</li>
3430 <li><strong>Handle Utilities</strong> - Register and re-register study handles.</li>
3431 </ul>
3432 <p><strong>Study Utilities</strong></p>
3433 <p>Curating a large group of studies sometimes requires direct database
3434 changes affecting a large number of studies that may belong to different
3435 dataverses. An example might be changing the distributor name and logo
3436 or the parent dataverse. Since the Dataverse Network employs study
3437 versioning, it was decided that any such backend changes should
3438 increment the affected studies&#8217; version. However, incrementing a study&#8217;s
3439 version is nontrivial as a database update. So, this utility to create a
3440 draft of an existing study was created.</p>
3441 <p>The practice would involve generating a list of study database ID&#8217;s that
3442 need changing, use the utility to create drafts of those studies, then
3443 run the database update scripts. The result is new, unreleased draft
3444 versions of studies with modifications made directly through the
3445 database. These studies would then need to be reviewed and released
3446 manually.</p>
3447 <p>Due to the transactional nature of study updates, particularly when
3448 uploading large files, it is possible a study update is interrupted such
3449 as during a system restart. When this occurs, the study lock, created to
3450 prevent simultaneous updates while one is already in progress, remains
3451 and the study cannot be edited until it is cleared.</p>
3452 <p>Checking for this condition and clearing it is easy. Open this utility,
3453 check if any locks are listed and remove them. The user should once
3454 again be able to edit their study.</p>
3455 <p>The user interface provides a convenient way to delete individual
3456 studies but when faced with deleting a large number of studies that do
3457 not conveniently belong to a single dataverse, use the Delete utility.</p>
3458 <p>Specify studies by their database id single, as a comma-separated list
3459 (1,7,200, etc.), or as a hyphen-separated range (1-1000, 2005,
3460 2500-2700).</p>
3461 <p><strong>Index Utilities</strong></p>
3462 <p>Indexing is the process of making study metadata searchable. The Lucence
3463 search engine used by the Dataverse Network uses file-based indexes.
3464 Normally, any time a study or new study version is released the study
3465 information is automatically indexed. Harvesting also indexes studies in
3466 small batches as they are harvested. Sometimes this does not occur, such
3467 as when the harvest process is interrupted. The index could also become
3468 corrupt for some reason though this would be extremely rare.</p>
3469 <p>The index utility allows for reindexing of studies, dataverses, and the
3470 entire site. Studies and dataverses can be specified by their database
3471 id&#8217;s alone, in a comma separated list, or in a hyphenated range: 1-1000.
3472 Use index all sparingly, particularly if you have a large site. This is
3473 a single transaction and should not be interrupted or you will need to
3474 start again. A more flexible approach is to determine the lowest and
3475 highest study ID&#8217;s and index in smaller ranges: 1-1000, 1001-2000, etc.</p>
3476 <p>Note: if for some reason a study change was not indexed, there is an
3477 automatic background process that will detect this, inform the
3478 administrator and will be reindexed once every 24 hours so manually
3479 reindexing is not required.</p>
3480 <p><strong>Export Utilities</strong></p>
3481 <p>Export is a background process that normally runs once every 24 hours.
3482 Its purpose is to produce study metadata files in well known formats
3483 such as DDI, DC, MIF, and FGDC that can be used to import studies to
3484 other systems such as through harvesting.</p>
3485 <p>Sometimes it&#8217;s useful to manually export a study, dataverse, any updated
3486 studies, or all studies. Studies and dataverses are specified by
3487 database id rather than global id or handle.</p>
3488 <p>Export is tied to OAI set creation and Harvesting. To enable harvesting
3489 of a subset of studies by another site, first an OAI set is created that
3490 defines the group of studies. Next, the scheduled export runs and
3491 creates the export files if they&#8217;re not already available. It also
3492 associates those studies defined by the set with the set name so future
3493 requests for the set receive updates&nbsp;— additions or deletions from the
3494 set. This way remote sites harvesting the set maintain an updated study
3495 list.</p>
3496 <p>If you do not want to wait 24 hours to test harvest a newly created set,
3497 use the export utility. Click &#8220;Run Export&#8221; to export any changed studies
3498 and associate studies to the set. Exporting studies or dataverses alone
3499 will not associate studies to a set, in those cases Update Harvest
3500 Studies must also be run.</p>
3501 <p><strong>Harvest Utilities</strong></p>
3502 <p>The Harvest utility allows for on-demand harvesting of a single study.
3503 First select one of the predefined harvesting dataverses which provide
3504 remote server connection information as well as the local dataverse
3505 where the study will be harvested to. Specify the harvest ID of the
3506 study to be harvested. The harvest id is particular to the study and
3507 server being harvested from. It can be obtained from the OAI protocol
3508 ListIdentifiers command, from the harvest log if previously harvested,
3509 or if from another DVN it takes the form: &lt;OAI set alias&gt;//&lt;global id&gt;.
3510 A&nbsp;Dataverse Network study with <tt class="docutils literal"><span class="pre">globalID:</span> <span class="pre">hdl:1902.1/10004</span></tt>, from the OAI
3511 set &#8220;My Set&#8221;, having alias &#8220;myset&#8221;, would have a harvest identifier of:
3512 <tt class="docutils literal"><span class="pre">myset//hdl:1902.1/10004</span></tt></p>
3513 <p><strong>File Utilities</strong></p>
3514 <p>The Dataverse Network attempts to identify file types on upload to
3515 provide more information to an end user. It does this by calling a file
3516 type identification library called JHOVE. Though JHOVE is a very
3517 comprehensive library, sometimes a file type may not be recognized or is
3518 similar to another type and misidentified. For these cases we provide an
3519 override mechanism&nbsp;— a list of file extensions and a brief text
3520 description. Since these are created after the files have been uploaded,
3521 this file utility provides a way to re-identify the file types and
3522 furthermore limits this process to specific file types or to studies,
3523 specified by database ID singly, as a comma separated, or as a
3524 hype-separated range.</p>
3525 <p><strong>Import Utilities</strong></p>
3526 <p>Importing studies usually is done by harvesting study metadata from a
3527 remote site via the OAI protocol. This causes study metadata to be
3528 hosted locally but files are served by the remote server. The Import
3529 utility is provided for cases where an OAI server is unavailable or
3530 where the intent is to relocate studies and their files to the Dataverse
3531 Network.</p>
3532 <p>At present this requires the help of the network administrator and can
3533 be manually intensive. First, study metadata may need to be modified
3534 slightly then saved in a specific directory structure on the server file
3535 system. Next, the study metadata import format and destination dataverse
3536 is chosen. Last, the top level directory where the study metadata and
3537 files are stored and &#8220;Batch Import&#8221; is clicked. Because the DDI input
3538 format can be quite complex and usage varies, verify the results are
3539 what&#8217;s intended.</p>
3540 <p>A single study import function is also provided as a test for importing
3541 your study&#8217;s metadata syntax but is not meant for actual import. It will
3542 not import associated files.</p>
3543 <p>Before performing a batch import, you must organize your files in the
3544 following manner:</p>
3545 <ol class="arabic simple">
3546 <li>If you plan to import multiple files or studies, create a master
3547 directory to hold all content that you choose to import.</li>
3548 <li>Create a separate subdirectory for each study that you choose to
3549 import.
3550 The directory name is not important.</li>
3551 <li>In each directory, place a file called <tt class="docutils literal"><span class="pre">study.xml</span></tt> and use that
3552 file to hold the XML-formatted record for one study.
3553 Note: Do not include file description elements in
3554 the <tt class="docutils literal"><span class="pre">study.xml</span></tt> file. Including those fields results in the
3555 addition of multiple blank files to that study.</li>
3556 <li>Also place in the directory any additional files that you choose to
3557 upload for that study.</li>
3558 </ol>
3559 <p>For an example of a simple study DDI, refer to the <a class="reference internal" href="#metadata-references"><em>Metadata References</em></a>
3560 section.</p>
3561 <p><strong>Handle Utilities</strong></p>
3562 <p>When a study is created, the global ID is first assigned, then
3563 registered with handle.net as a persistent identifier. This identifier
3564 becomes part of the study&#8217;s citation and is guaranteed to always resolve
3565 to the study. For the study with global ID, <a class="reference external" href="hdl:1902.1/16598">hdl:1902.1/16598</a> or handle
3566 1902.1/16596, the URL in the citation would be:
3567 <a class="reference external" href="http://hdl.handle.net/1902.1/16598">http://hdl.handle.net/1902.1/16598</a>.</p>
3568 <p>If for any reason a study is created and not registered or is registered
3569 in a way that needs to be changed, use the Handle utility to either
3570 register currently unregistered studies or to re-register all registered
3571 studies.</p>
3572 </div>
3573 <div class="section" id="web-statistics">
3574 <h3>Web Statistics<a class="headerlink" href="#web-statistics" title="Permalink to this headline">¶</a></h3>
3575 <p>The Dataverse Network provides the capability to compile and analyze
3576 site usage through Google Analytics. A small amount of code is embedded
3577 in each page so when enabled, any page access along with associated
3578 browser and user information is recorded by Google. Later analysis of
3579 this compiled access data can be performed using the <a class="reference external" href="http://www.google.com/analytics/">Google Analytics</a> utility.</p>
3580 <p>Note: Access to Google Analytics is optional. If access to this utility
3581 is not configured for your network, in place of the Manage Web Usage
3582 menu option is a message
3583 stating: <tt class="docutils literal"><span class="pre">Google</span> <span class="pre">Analytics</span> <span class="pre">are</span> <span class="pre">not</span> <span class="pre">configured</span> <span class="pre">for</span> <span class="pre">this</span> <span class="pre">Network.</span></tt></p>
3584 <p><strong>To enable Google Analytics:</strong></p>
3585 <ol class="arabic simple">
3586 <li>Create a Gmail account.</li>
3587 <li>Go to <a class="reference external" href="http://www.google.com/analytics/">Google Analytics</a> and create a profile for the server or website domain. You will
3588 be assigned a Web Property ID.</li>
3589 <li>Using the Glassfish Admin console, add a JVM option and assign it the value of the newly assigned Web Property ID:
3590 <tt class="docutils literal"><span class="pre">Ddvn.googleanalytics.key=</span></tt></li>
3591 <li>Restart Glassfish.</li>
3592 <li>It takes about 24 hours after installation and set up of this option for tracking data to become available for use.</li>
3593 </ol>
3594 <p>Note: Google provides the code necessary for tracking. This has already
3595 been embedded into the Dataverse Network but not the Web Property ID.
3596 That is configured as a JVM option by the network admin when enabling
3597 this feature.</p>
3598 <p><strong>To view Web Statistics, navigate to:</strong></p>
3599 <ul class="simple">
3600 <li>Network home page &gt; Options page &gt; Settings tab &gt; General subtab &gt; Web Statistics</li>
3601 <li>You will be redirected to <a class="reference external" href="http://www.google.com/analytics/">Google Analytics</a>. Log in using your Gmail account used to
3602 create the profile.</li>
3603 </ul>
3604 </div>
3605 </div>
3606 <div class="section" id="appendix">
3607 <h2>Appendix<a class="headerlink" href="#appendix" title="Permalink to this headline">¶</a></h2>
3608 <p>Additional documentation complementary to Users Guides.</p>
3609 <div class="section" id="control-card-based-data-ingest">
3610 <h3>Control Card-Based Data Ingest<a class="headerlink" href="#control-card-based-data-ingest" title="Permalink to this headline">¶</a></h3>
3611 <p>As of version 2.2 the DVN supports ingesting plain text data files, in
3612 addition to SPSS and STATA formats. This allows users and institutions
3613 to ingest raw data into Dataverse Networks without having to purchase
3614 and maintain proprietary, commercial software packages.</p>
3615 <p>Tab-delimited and CSV files are supported. In order to ingest a plain
3616 data file, an additional file containing the variable metadata needs to
3617 be supplied.</p>
3618 <p><strong>Two Metadata Types Are Supported</strong></p>
3619 <ol class="arabic simple">
3620 <li>A simplified format based on the classic SPSS control card syntax;
3621 this appears as &#8220;CSV/SPSS&#8221; in the menu on the Add Files page.</li>
3622 <li>DDI, an xml format from the Data Documentation Inititative
3623 consortium. Choose &#8220;TAB/DDI&#8221; to ingest a tab file with a DDI metadata sheet.</li>
3624 </ol>
3625 <p>The specifics of the formats are documented in the 2 sections below.</p>
3626 <div class="section" id="csv-data-spss-style-control-card">
3627 <span id="controlcard-datafile-ingest"></span><h4>CSV Data, SPSS-style Control Card<a class="headerlink" href="#csv-data-spss-style-control-card" title="Permalink to this headline">¶</a></h4>
3628 <p>Unlike other supported “subsettable” formats, this ingest mechanism
3629 requires 2 files: the CSV raw data file proper and an SPSS Setup file
3630 (&#8220;control card&#8221;) with the data set metadata. In the future, support for
3631 other data definition formats may be added (STATA, SAS, etc.). As
3632 always, user feedback is welcome.</p>
3633 <p><strong>The supported SPSS command syntax:</strong></p>
3634 <p>Please note that it is not our goal to attempt to support any set of
3635 arbitrary SPSS commands and/or syntax variations. The goal is to enable
3636 users who do not own proprietary statistical software to prepare their
3637 raw data for DVN ingest, using a select subset of SPSS data definitional
3638 syntax.</p>
3639 <p>(In addition to its simplicity and popularity, we chose to use the SPSS
3640 command syntax because Dataverse Network already has support for the SPSS <tt class="docutils literal"><span class="pre">.SAV</span></tt> and <tt class="docutils literal"><span class="pre">.POR</span></tt> formats, so we have a good working knowledge of the SPSS formatting
3641 conventions.)</p>
3642 <p>The following SPSS commands are supported:</p>
3643 <div class="line-block">
3644 <div class="line"><tt class="docutils literal"><span class="pre">DATA</span> <span class="pre">LIST&nbsp;</span></tt></div>
3645 <div class="line"><tt class="docutils literal"><span class="pre">VARIABLE</span> <span class="pre">LABELS&nbsp;</span></tt></div>
3646 <div class="line"><tt class="docutils literal"><span class="pre">NUMBER</span> <span class="pre">OF</span> <span class="pre">CASES</span></tt></div>
3647 <div class="line"><tt class="docutils literal"><span class="pre">VALUE</span> <span class="pre">LABELS</span></tt></div>
3648 <div class="line"><tt class="docutils literal"><span class="pre">FORMATS</span></tt> (actually, not supported as of now &#8211; see below)</div>
3649 <div class="line"><tt class="docutils literal"><span class="pre">MISSING</span> <span class="pre">VALUES</span></tt></div>
3650 </div>
3651 <p>We support mixed cases and all the abbreviations of the above commands
3652 that are valid under SPSS. For example, both &#8220;var labels&#8221; and &#8220;Var Lab&#8221;
3653 are acceptable commands.</p>
3654 <p>Individual command syntax.</p>
3655 <p><strong>1. DATA LIST</strong></p>
3656 <p>An explicit delimiter definition is required. For example:</p>
3657 <p><tt class="docutils literal"><span class="pre">DATA</span> <span class="pre">LIST</span> <span class="pre">LIST(',')</span></tt></p>
3658 <p>specifies <tt class="docutils literal"><span class="pre">','</span></tt> as the delimiter. This line is followed by the <tt class="docutils literal"><span class="pre">'/'</span></tt>
3659 separator and variable definitions. Explicit type definitions are
3660 required. Each variable is defined by a name/value pair <tt class="docutils literal"><span class="pre">VARNAME</span></tt></p>
3661 <p><tt class="docutils literal"><span class="pre">(VARTYPE)</span></tt> where <tt class="docutils literal"><span class="pre">VARTYPE</span></tt> is a standard SPSS fortran-type
3662 definition.</p>
3663 <p><strong>Note</strong> that this is the only <strong>required</strong> section. The minimum
3664 amount of metadata required to ingest a raw data file is the delimiter
3665 character, the names of the variables and their data type. All of these
3666 are defined in the <tt class="docutils literal"><span class="pre">DATA</span> <span class="pre">LIST</span></tt> section. Here’s an example of a
3667 complete, valid control card:</p>
3668 <p><tt class="docutils literal"><span class="pre">DATA</span> <span class="pre">LIST</span> <span class="pre">LIST(’,’)</span></tt>
3669 <tt class="docutils literal"><span class="pre">CASEID</span> <span class="pre">(f)</span> <span class="pre">NAME</span> <span class="pre">(A)</span> <span class="pre">RATIO</span> <span class="pre">(f)</span></tt>
3670 <tt class="docutils literal"><span class="pre">.</span></tt></p>
3671 <p>It defines a comma-separated file with 3 variables named <tt class="docutils literal"><span class="pre">CASEID</span></tt>,
3672 <tt class="docutils literal"><span class="pre">NAME</span></tt> and <tt class="docutils literal"><span class="pre">RATIO</span></tt>, two of them of the types numeric and one character
3673 string.</p>
3674 <p>Examples of valid type definitions:</p>
3675 <div class="line-block">
3676 <div class="line"><strong>A8</strong> 8 byte character string;</div>
3677 <div class="line"><strong>A</strong> character string;</div>
3678 <div class="line"><strong>f10.2</strong> numeric value, 10 decimal digits, with 2 fractional digits;</div>
3679 <div class="line"><strong>f8</strong> defaults to F8.0</div>
3680 <div class="line"><strong>F</strong> defaults to F.0, i.e., numeric integer value</div>
3681 <div class="line"><strong>2</strong> defaults to F.2, i.e., numeric float value with 2 fractional digits.</div>
3682 </div>
3683 <p>The following SPSS date/time types are supported:</p>
3684 <p>type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; format</p>
3685 <p><tt class="docutils literal"><span class="pre">DATE``&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``yyyy-MM-dd</span></tt></p>
3686 <p><tt class="docutils literal"><span class="pre">DATETIME``&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``yyyy-MM-dd</span> <span class="pre">HH:mm:ss</span></tt></p>
3687 <p>The variable definition pairs may be separated by any combination of
3688 white space characters and newlines.&nbsp;<strong>Wrapped-around lines must start
3689 with white spaces</strong>&nbsp;(i.e., newlines must be followed by spaces). The
3690 list must be terminated by a line containing a single dot.</p>
3691 <p>Please note, that the actual date values should be stored in the CSV
3692 file as strings, in the format above. As opposed to how SPSS stores the
3693 types of the same name (as integer numbers of seconds).</p>
3694 <p><strong>2. VARIABLE LABELS</strong></p>
3695 <p>Simple name/value pairs, separated by any combination of white space
3696 characters and newlines (as described in section 1 above). The list is
3697 terminated by a single dot.</p>
3698 <p>For example:</p>
3699 <div class="line-block">
3700 <div class="line"><tt class="docutils literal"><span class="pre">VARIABLE</span> <span class="pre">LABELS</span></tt></div>
3701 <div class="line"><tt class="docutils literal"><span class="pre">CELLS</span> <span class="pre">&quot;Subgroups</span> <span class="pre">for</span> <span class="pre">sample-see</span> <span class="pre">documentation&quot;</span></tt></div>
3702 <div class="line"><tt class="docutils literal"><span class="pre">STRATA</span> <span class="pre">&quot;Cell</span> <span class="pre">aggregates</span> <span class="pre">for</span> <span class="pre">sample”</span></tt></div>
3703 <div class="line"><tt class="docutils literal"><span class="pre">.</span></tt></div>
3704 </div>
3705 <p><strong>3. NUMBER OF CASES (optional)</strong></p>
3706 <p>The number of cases may be explicitly specified. For example:</p>
3707 <p><tt class="docutils literal"><span class="pre">num</span> <span class="pre">of</span> <span class="pre">cases</span> <span class="pre">1000</span></tt></p>
3708 <p>When the number of cases is specified, it will be checked against the
3709 number of observations actually found in the CSV file, and a mismatch
3710 would result in an ingest error.</p>
3711 <p><strong>4. VALUE LABELS</strong></p>
3712 <p>Each value label section is a variable name followed by a list of
3713 value/label pairs, terminated by a single &#8220;/&#8221; character. The list of
3714 value label sections is terminated by a single dot.</p>
3715 <p>For example,</p>
3716 <div class="line-block">
3717 <div class="line"><tt class="docutils literal"><span class="pre">VALUE</span> <span class="pre">labels</span></tt></div>
3718 <div class="line"><tt class="docutils literal"><span class="pre">FOO</span> <span class="pre">0</span> <span class="pre">&quot;NADA&quot;</span></tt></div>
3719 <div class="line"><tt class="docutils literal"><span class="pre">1</span> <span class="pre">&quot;NOT</span> <span class="pre">MUCH&quot;</span></tt></div>
3720 <div class="line"><tt class="docutils literal"><span class="pre">99999999</span> <span class="pre">&quot;A</span> <span class="pre">LOT&quot;</span></tt></div>
3721 <div class="line"><tt class="docutils literal"><span class="pre">/</span></tt></div>
3722 <div class="line"><tt class="docutils literal"><span class="pre">BAR</span> <span class="pre">97</span> <span class="pre">&quot;REFUSAL&quot;</span></tt></div>
3723 <div class="line"><tt class="docutils literal"><span class="pre">98</span> <span class="pre">&quot;DONT</span> <span class="pre">KNOW&quot;</span></tt></div>
3724 <div class="line"><tt class="docutils literal"><span class="pre">99</span> <span class="pre">&quot;MISSING&quot;</span></tt></div>
3725 <div class="line"><tt class="docutils literal"><span class="pre">/</span></tt></div>
3726 <div class="line"><tt class="docutils literal"><span class="pre">.</span></tt></div>
3727 </div>
3728 <p><strong>5. FORMATS</strong></p>
3729 <p>This command is actually redundant if you explicitly supply the variable
3730 formats in the&nbsp;<a href="#id21"><span class="problematic" id="id22">``</span></a>DATA LIST``&nbsp;section above.</p>
3731 <p><strong>NOTE:</strong> It appears that the only reason the``FORMATS`` command exists is
3732 that <tt class="docutils literal"><span class="pre">DATA</span> <span class="pre">LIST</span></tt> syntax does not support explicit fortran-style format
3733 definitions when fixed-field data is defined. So it is in fact redundant
3734 when we&#8217;re dealing with delimited files only.</p>
3735 <p>Please supply valid, fortran-style variable formats in the&nbsp;<a href="#id23"><span class="problematic" id="id24">``</span></a>DATA
3736 LIST``&nbsp;section, as described above.</p>
3737 <p><strong>6. MISSING VALUES</strong></p>
3738 <p>This is a space/newline-separate list of variable names followed by a
3739 comma-separated list of missing values definition, in parentheses. For
3740 example:</p>
3741 <div class="line-block">
3742 <div class="line"><tt class="docutils literal"><span class="pre">INTVU4</span> <span class="pre">(97,</span> <span class="pre">98,</span> <span class="pre">99)</span></tt></div>
3743 <div class="line">The list is terminated with a single dot.</div>
3744 </div>
3745 <p>An example of a valid&nbsp;<a href="#id25"><span class="problematic" id="id26">``</span></a>MISSING VALUES``&nbsp;control card section:</p>
3746 <div class="line-block">
3747 <div class="line"><tt class="docutils literal"><span class="pre">MISSING</span> <span class="pre">VALUES</span></tt></div>
3748 <div class="line"><tt class="docutils literal"><span class="pre">INTVU4</span> <span class="pre">(97,</span> <span class="pre">98,</span> <span class="pre">99)</span></tt></div>
3749 <div class="line"><tt class="docutils literal"><span class="pre">INTVU4A</span> <span class="pre">('97',</span> <span class="pre">'98',</span> <span class="pre">'99')</span></tt></div>
3750 <div class="line"><tt class="docutils literal"><span class="pre">.</span></tt></div>
3751 </div>
3752 <div class="line-block">
3753 <div class="line"><strong>An example of a control card ready for ingest:</strong></div>
3754 </div>
3755 <div class="highlight-guess"><div class="highlight"><pre><span class="n">data</span> <span class="n">list</span> <span class="n">list</span><span class="p">(</span><span class="sc">&#39;,&#39;</span><span class="p">)</span> <span class="o">/</span>
3756 <span class="n">CELLS</span> <span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="n">STRATA</span> <span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="n">WT2517</span> <span class="p">(</span><span class="mi">2</span><span class="p">)</span>
3757 <span class="n">SCRNRID</span> <span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="n">CASEID</span> <span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="n">INTVU1</span> <span class="p">(</span><span class="n">f</span><span class="p">)</span>
3758 <span class="n">INTVU2</span> <span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="n">INTVU3</span> <span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="n">INTVU4</span> <span class="p">(</span><span class="n">f</span><span class="p">)</span>
3759 <span class="n">INTVU4A</span> <span class="p">(</span><span class="n">A</span><span class="p">)</span>
3760 <span class="p">.</span>
3761 <span class="n">VARIABLE</span> <span class="n">LABELS</span>
3762 <span class="n">CELLS</span> <span class="s">&quot;Subgroups for sample-see documentation&quot;</span>
3763 <span class="n">STRATA</span> <span class="s">&quot;Cell aggregates for sample-see documenta&quot;</span>
3764 <span class="n">WT2517</span> <span class="s">&quot;weight for rep. sample-see documentation&quot;</span>
3765 <span class="n">SCRNRID</span> <span class="s">&quot;SCREENER-ID&quot;</span>
3766 <span class="n">CASEID</span> <span class="s">&quot;RESPONDENT&#39;S CASE ID NUMBER&quot;</span>
3767 <span class="n">INTVU1</span> <span class="s">&quot;MONTH RESPONDENT BEGAN INTERVIEW&quot;</span>
3768 <span class="n">INTVU2</span> <span class="s">&quot;DAY RESPONDENT BEGAN INTERVIEW&quot;</span>
3769 <span class="n">INTVU3</span> <span class="s">&quot;HOUR RESPONDENT BEGAN INTERVIEW&quot;</span>
3770 <span class="n">INTVU4</span> <span class="s">&quot;MINUTE RESPONDENT BEGAN INTERVIEW&quot;</span>
3771 <span class="n">INTVU4A</span> <span class="s">&quot;RESPONDENT INTERVIEW BEGAN AM OR PM&quot;</span>
3772 <span class="p">.</span>
3773 <span class="n">VALUE</span> <span class="n">labels</span>
3774 <span class="n">CASEID</span> <span class="mi">99999997</span> <span class="s">&quot;REFUSAL&quot;</span>
3775 <span class="mi">99999998</span> <span class="s">&quot;DONT KNOW&quot;</span>
3776 <span class="mi">99999999</span> <span class="s">&quot;MISSING&quot;</span>
3777 <span class="o">/</span>
3778 <span class="n">INTVU1</span> <span class="mi">97</span> <span class="s">&quot;REFUSAL&quot;</span>
3779 <span class="mi">98</span> <span class="s">&quot;DONT KNOW&quot;</span>
3780 <span class="mi">99</span> <span class="s">&quot;MISSING&quot;</span>
3781 <span class="o">/</span>
3782 <span class="n">INTVU2</span> <span class="mi">97</span> <span class="s">&quot;REFUSAL&quot;</span>
3783 <span class="mi">98</span> <span class="s">&quot;DONT KNOW&quot;</span>
3784 <span class="mi">99</span> <span class="s">&quot;MISSING&quot;</span>
3785 <span class="o">/</span>
3786 <span class="n">INTVU3</span> <span class="mi">97</span> <span class="s">&quot;REFUSAL&quot;</span>
3787 <span class="mi">98</span> <span class="s">&quot;DONT KNOW&quot;</span>
3788 <span class="mi">99</span> <span class="s">&quot;MISSING&quot;</span>
3789 <span class="o">/</span>
3790 <span class="n">INTVU4</span> <span class="mi">97</span> <span class="s">&quot;REFUSAL&quot;</span>
3791 <span class="mi">98</span> <span class="s">&quot;DONT KNOW&quot;</span>
3792 <span class="mi">99</span> <span class="s">&quot;MISSING&quot;</span>
3793 <span class="o">/</span>
3794 <span class="n">INTVU4A</span> <span class="s">&quot;97&quot;</span> <span class="s">&quot;REFUSAL&quot;</span>
3795 <span class="s">&quot;98&quot;</span> <span class="s">&quot;DONT KNOW&quot;</span>
3796 <span class="s">&quot;99&quot;</span> <span class="s">&quot;MISSING&quot;</span>
3797 <span class="s">&quot;AM&quot;</span> <span class="s">&quot;MORNING&quot;</span>
3798 <span class="s">&quot;PM&quot;</span> <span class="s">&quot;EVENING&quot;</span>
3799 <span class="p">.</span>
3800 <span class="n">MISSING</span> <span class="n">VALUES</span>
3801 <span class="n">CASEID</span> <span class="p">(</span><span class="mi">99999997</span><span class="p">,</span> <span class="mi">99999998</span><span class="p">,</span> <span class="mi">99999999</span><span class="p">)</span>
3802 <span class="n">INTVU1</span> <span class="p">(</span><span class="mi">97</span><span class="p">,</span> <span class="mi">98</span><span class="p">,</span> <span class="mi">99</span><span class="p">)</span>
3803 <span class="n">INTVU2</span> <span class="p">(</span><span class="mi">97</span><span class="p">,</span> <span class="mi">98</span><span class="p">,</span> <span class="mi">99</span><span class="p">)</span>
3804 <span class="n">INTVU3</span> <span class="p">(</span><span class="mi">97</span><span class="p">,</span> <span class="mi">98</span><span class="p">,</span> <span class="mi">99</span><span class="p">)</span>
3805 <span class="n">INTVU4</span> <span class="p">(</span><span class="mi">97</span><span class="p">,</span> <span class="mi">98</span><span class="p">,</span> <span class="mi">99</span><span class="p">)</span>
3806 <span class="n">INTVU4A</span> <span class="p">(</span><span class="err">&#39;</span><span class="mi">97</span><span class="err">&#39;</span><span class="p">,</span> <span class="err">&#39;</span><span class="mi">98</span><span class="err">&#39;</span><span class="p">,</span> <span class="err">&#39;</span><span class="mi">99</span><span class="err">&#39;</span><span class="p">)</span>
3807 <span class="p">.</span>
3808 <span class="n">NUMBER</span> <span class="n">of</span> <span class="n">CASES</span> <span class="mi">2517</span>
3809 </pre></div>
3810 </div>
3811 <p><strong>DATA FILE.</strong></p>
3812 <p>Data must be stored in a text file, one observation per line. Both DOS
3813 and Unix new line characters are supported as line separators. On each
3814 line, individual values must be separated by the delimiter character
3815 defined in the&nbsp;DATA LISTsection. There may only be exactly&nbsp;(<tt class="docutils literal"><span class="pre">NUMBER</span> <span class="pre">OF</span>
3816 <span class="pre">VARIABLES</span> <span class="pre">-</span> <span class="pre">1</span></tt>)&nbsp;delimiter characters per line; i.e. character values must
3817 not contain the delimiter character.</p>
3818 <p><strong>QUESTIONS, TODOS:</strong></p>
3819 <p>Is there any reason we may want to support <tt class="docutils literal"><span class="pre">RECODE</span></tt> command also?</p>
3820 <p>&#8212; comments, suggestions are welcome! &#8212;</p>
3821 </div>
3822 <div class="section" id="tab-data-with-ddi-metadata">
3823 <span id="ddixml-datafile-ingest"></span><h4>Tab Data, with DDI Metadata<a class="headerlink" href="#tab-data-with-ddi-metadata" title="Permalink to this headline">¶</a></h4>
3824 <p>As of version 2.2, another method of ingesting raw TAB-delimited data
3825 files has been added to the Dataverse Network. Similarly to the SPSS control
3826 card-based ingest (also added in this release), this ingest mechanism
3827 requires 2 files: the TAB raw data file itself and the data set metadata
3828 in the DDI/XML format.</p>
3829 <p><strong>Intended use case:</strong></p>
3830 <p>Similarly to the SPSS syntax-based ingest, the goal is to provide
3831 another method of ingesting raw quantitative data into the DVN, without
3832 having to first convert it into one of the proprietary, commercial
3833 formats, such as SPSS or STATA. Pleaes note, that in our design
3834 scenario, the DDI files supplying the ingest metadata will be somehow
3835 machine-generated; by some software tool, script, etc. In other words,
3836 this design method is targeted towards more of an institutional user,
3837 perhaps another data archive with large quantities of data and some
3838 institutional knowledge of its structure, and with some resources to
3839 invest into developing an automated tool to generate the metadata
3840 describing the datasets. With the final goal of ingesting all the data
3841 into a DVN by another automated, batch process. The DVN project is also
3842 considering developing a standalone tool of our own that would guide
3843 users through the process of gathering the information describing their
3844 data sets and producing properly formatted DDIs ready to be ingested.</p>
3845 <p>For now, if you are merely looking for a way to ingest a single
3846 “subsettable” data set, you should definitely be able to create a
3847 working DDI by hand to achieve this goal. However, we strongly recommend
3848 that you instead consider the CSV/SPSS control card method, which was
3849 designed with this use case in mind. If anything, it will take
3850 considerably fewer keystrokes to create an SPSS-syntax control card than
3851 a DDI encoding the same amount of information.</p>
3852 <p><strong>The supported DDI syntax:</strong></p>
3853 <p>You can consult the DDI project for complete information on the DDI
3854 metadata (<a class="reference external" href="http://icpsr.umich.edu/DDI">http://icpsr.umich.edu/DDI</a>).
3855 However, only a small subset of the published format syntax is used for
3856 ingesting individual data sets. Of the 7 main DDI sections, only 2,
3857 fileDscr and dataDscr are used. Inside these sections, only a select set
3858 of fields, those that have direct equivalents in the DVN data set
3859 structure, are supported.</p>
3860 <p>These fields are outlined below. All the fields are mandatory, unless
3861 specified otherwise. An XSD schema of the format subset is also
3862 provided, for automated validation of machine-generated XML.</p>
3863 <div class="highlight-guess"><div class="highlight"><pre><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
3864 <span class="nt">&lt;codeBook</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.icpsr.umich.edu/DDI&quot;</span><span class="err">\</span><span class="nt">&gt;</span>
3865 <span class="nt">&lt;fileDscr&gt;</span>
3866 <span class="nt">&lt;fileTxt</span> <span class="na">ID=</span><span class="s">&quot;file1&quot;</span><span class="nt">&gt;</span>
3867 <span class="nt">&lt;dimensns&gt;</span>
3868 <span class="nt">&lt;caseQnty&gt;</span>NUMBER OF OBSERVATIONS<span class="nt">&lt;/caseQnty&gt;</span>
3869 <span class="nt">&lt;varQnty&gt;</span>NUMBER OF VARIABLES<span class="nt">&lt;/varQnty&gt;</span>
3870 <span class="nt">&lt;/dimensns&gt;</span>
3871 <span class="nt">&lt;/fileTxt&gt;</span>
3872 <span class="nt">&lt;/fileDscr&gt;</span>
3873 <span class="nt">&lt;dataDscr&gt;</span>
3874 <span class="c">&lt;!-- var section for a discrete numeric variable: --&gt;</span>
3875 <span class="nt">&lt;var</span> <span class="na">ID=</span><span class="s">&quot;v1.1&quot;</span> <span class="na">name=</span><span class="s">&quot;VARIABLE NAME&quot;</span> <span class="na">intrvl=</span><span class="s">&quot;discrete&quot;</span> <span class="nt">&gt;</span>
3876 <span class="nt">&lt;location</span> <span class="na">fileid=</span><span class="s">&quot;file1&quot;</span><span class="nt">/&gt;</span>
3877 <span class="nt">&lt;labl</span> <span class="na">level=</span><span class="s">&quot;variable&quot;</span><span class="nt">&gt;</span>VARIABLE LABEL<span class="nt">&lt;/labl&gt;</span>
3878 <span class="nt">&lt;catgry&gt;</span>
3879 <span class="nt">&lt;catValu&gt;</span>CATEGORY VALUE<span class="nt">&lt;/catValu&gt;</span>
3880 <span class="nt">&lt;/catgry&gt;</span>
3881
3882 <span class="c">&lt;!-- 1 or more category sections are allowed for discrete variables --&gt;</span>
3883 <span class="nt">&lt;varFormat</span> <span class="na">type=</span><span class="s">&quot;numeric&quot;</span> <span class="nt">/&gt;</span>
3884 <span class="nt">&lt;/var&gt;</span>
3885 <span class="c">&lt;!-- var section for a continuous numeric variable: --&gt;</span>
3886 <span class="nt">&lt;var</span> <span class="na">ID=</span><span class="s">&quot;v1.2&quot;</span> <span class="na">name=</span><span class="s">&quot;VARIABLE NAME&quot;</span> <span class="na">intrvl=</span><span class="s">&quot;contin&quot;</span> <span class="nt">&gt;</span>
3887 <span class="nt">&lt;location</span> <span class="na">fileid=</span><span class="s">&quot;file1&quot;</span><span class="nt">/&gt;</span>
3888 <span class="nt">&lt;labl</span> <span class="na">level=</span><span class="s">&quot;variable&quot;</span><span class="nt">&gt;</span>VARIABLE LABEL<span class="nt">&lt;/labl&gt;</span>
3889 <span class="nt">&lt;varFormat</span> <span class="na">type=</span><span class="s">&quot;numeric&quot;</span> <span class="nt">/&gt;</span>
3890 <span class="nt">&lt;/var&gt;</span>
3891 <span class="c">&lt;!-- var section for a character (string) variable: --&gt;</span>
3892 <span class="nt">&lt;var</span> <span class="na">ID=</span><span class="s">&quot;v1.10&quot;</span> <span class="na">name=</span><span class="s">&quot;VARIABLE NAME&quot;</span> <span class="na">intrvl=</span><span class="s">&quot;discrete&quot;</span> <span class="nt">&gt;</span>
3893 <span class="nt">&lt;location</span> <span class="na">fileid=</span><span class="s">&quot;file1&quot;</span><span class="nt">/&gt;</span>
3894 <span class="nt">&lt;labl</span> <span class="na">level=</span><span class="s">&quot;variable&quot;</span><span class="nt">&gt;</span>VARIABLE LABEL<span class="nt">&lt;/labl&gt;</span>
3895 <span class="nt">&lt;varFormat</span> <span class="na">type=</span><span class="s">&quot;character&quot;</span> <span class="nt">/&gt;</span>
3896 <span class="nt">&lt;/var&gt;</span>
3897 <span class="c">&lt;!-- a discrete variable with missing values defined: --&gt;</span>
3898 <span class="nt">&lt;/dataDscr&gt;</span>
3899 <span class="nt">&lt;/codeBook&gt;</span>
3900 </pre></div>
3901 </div>
3902 <p>&#8212; comments, suggestions are welcome! &#8212;</p>
3903 </div>
3904 </div>
3905 <div class="section" id="spss-data-file-ingest">
3906 <span id="spss-datafile-ingest"></span><h3>SPSS Data File Ingest<a class="headerlink" href="#spss-data-file-ingest" title="Permalink to this headline">¶</a></h3>
3907 <div class="section" id="ingesting-spss-por-files-with-extended-labels">
3908 <h4>Ingesting SPSS (.por) files with extended labels<a class="headerlink" href="#ingesting-spss-por-files-with-extended-labels" title="Permalink to this headline">¶</a></h4>
3909 <p>This feature has been added to work around the limit on the length of
3910 variable labels in SPSS Portable (.por) files. To use this
3911 feature, select &#8220;SPSS/POR,(w/labels)&#8221; from the list of file types on
3912 the AddFiles page. You will be prompted to first upload a text file
3913 containing the extended, &#8220;long&#8221; versions of the labels, and then
3914 upload the .por file. The label text file should contain one
3915 TAB-separated variable name/variable label pair per line.</p>
3916 </div>
3917 </div>
3918 <div class="section" id="ingest-of-r-rdata-files">
3919 <span id="r-datafile-ingest"></span><h3>Ingest of R (.RData) files<a class="headerlink" href="#ingest-of-r-rdata-files" title="Permalink to this headline">¶</a></h3>
3920 <div class="section" id="overview">
3921 <h4>Overview.<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h4>
3922 <p>Support for ingesting R data files has been added in version 3.5. R
3923 has been increasingly popular in the research/academic community,
3924 owing to the fact that it is free and open-source (unlike SPSS and
3925 STATA). Consequently, more and more data is becoming available
3926 exclusively in RData format. This long-awaited feature makes it
3927 possible to ingest such data into DVN as &#8220;subsettable&#8221; files.</p>
3928 </div>
3929 <div class="section" id="requirements">
3930 <h4>Requirements.<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h4>
3931 <p>R ingest relies on R having been installed, configured and made
3932 available to the DVN application via RServe (see the Installers
3933 Guide). This is in contrast to the SPSS and Stata ingest - which can
3934 be performed without R present. (though R is still needed to perform
3935 most subsetting/analysis tasks on the resulting data files).</p>
3936 <p>The data must be formatted as an R dataframe (using data.frame() in
3937 R). If an .RData file contains multiple dataframes, only the 1st one
3938 will be ingested.</p>
3939 </div>
3940 <div class="section" id="data-types-compared-to-other-supported-formats-stat-spss">
3941 <h4>Data Types, compared to other supported formats (Stat, SPSS)<a class="headerlink" href="#data-types-compared-to-other-supported-formats-stat-spss" title="Permalink to this headline">¶</a></h4>
3942 <div class="section" id="integers-doubles-character-strings">
3943 <h5>Integers, Doubles, Character strings<a class="headerlink" href="#integers-doubles-character-strings" title="Permalink to this headline">¶</a></h5>
3944 <p>The handling of these types is intuitive and straightforward. The
3945 resulting tab file columns, summary statistics and UNF signatures
3946 should be identical to those produced by ingesting the same vectors
3947 from SPSS and Stata.</p>
3948 <p><strong>A couple of features that are unique to R/new in DVN:</strong></p>
3949 <p>R explicitly supports Missing Values for all of the types above;
3950 Missing Values encoded in R vectors will be recognized and preserved
3951 in TAB files (as &#8216;NA&#8217;), counted in the generated summary statistics
3952 and data analysis.</p>
3953 <p>In addition to Missing Values, R recognizes &#8220;Not a Number&#8221; (NaN) and
3954 positive and negative infinity for floating point values. These
3955 are now properly supported by the DVN.</p>
3956 <p>Also note that, unlike Stata, where &#8220;float&#8221; and &#8220;double&#8221; are supported
3957 as distinct data types, all floating point values in R are double
3958 precision.</p>
3959 </div>
3960 <div class="section" id="r-factors">
3961 <h5>R Factors<a class="headerlink" href="#r-factors" title="Permalink to this headline">¶</a></h5>
3962 <p>These are ingested as &#8220;Categorical Values&#8221; in the DVN.</p>
3963 <p>One thing to keep in mind: in both Stata and SPSS, the actual value of
3964 a categorical variable can be both character and numeric. In R, all
3965 factor values are strings, even if they are string representations of
3966 numbers. So the values of the resulting categoricals in the DVN will
3967 always be of string type too.</p>
3968 <div class="line-block">
3969 <div class="line"><strong>New:</strong> To properly handle <em>ordered factors</em> in R, the DVN now supports the concept of an &#8220;Ordered Categorical&#8221; - a categorical value where an explicit order is assigned to the list of value labels.</div>
3970 </div>
3971 </div>
3972 <div class="section" id="new-boolean-values">
3973 <h5>(New!) Boolean values<a class="headerlink" href="#new-boolean-values" title="Permalink to this headline">¶</a></h5>
3974 <p>R Boolean (logical) values are supported.</p>
3975 </div>
3976 <div class="section" id="limitations-of-r-data-format-as-compared-to-spss-and-stata">
3977 <h5>Limitations of R data format, as compared to SPSS and STATA.<a class="headerlink" href="#limitations-of-r-data-format-as-compared-to-spss-and-stata" title="Permalink to this headline">¶</a></h5>
3978 <p>Most noticeably, R lacks a standard mechanism for defining descriptive
3979 labels for the data frame variables. In the DVN, similarly to
3980 both Stata and SPSS, variables have distinct names and labels; with
3981 the latter reserved for longer, descriptive text.
3982 With variables ingested from R data frames the variable name will be
3983 used for both the &#8220;name&#8221; and the &#8220;label&#8221;.</p>
3984 <div class="line-block">
3985 <div class="line"><em>Optional R packages exist for providing descriptive variable labels;
3986 in one of the future versions support may be added for such a
3987 mechanism. It would of course work only for R files that were
3988 created with such optional packages</em>.</div>
3989 </div>
3990 <p>Similarly, R categorical values (factors) lack descriptive labels too.
3991 <strong>Note:</strong> This is potentially confusing, since R factors do
3992 actually have &#8220;labels&#8221;. This is a matter of terminology - an R
3993 factor&#8217;s label is in fact the same thing as the &#8220;value&#8221; of a
3994 categorical variable in SPSS or Stata and DVN; it contains the actual
3995 meaningful data for the given observation. It is NOT a field reserved
3996 for explanatory, human-readable text, such as the case with the
3997 SPSS/Stata &#8220;label&#8221;.</p>
3998 <p>Ingesting an R factor with the level labels &#8220;MALE&#8221; and &#8220;FEMALE&#8221; will
3999 produce a categorical variable with &#8220;MALE&#8221; and &#8220;FEMALE&#8221; in the
4000 values and labels both.</p>
4001 </div>
4002 </div>
4003 <div class="section" id="time-values-in-r">
4004 <h4>Time values in R<a class="headerlink" href="#time-values-in-r" title="Permalink to this headline">¶</a></h4>
4005 <p>This warrants a dedicated section of its own, because of some unique
4006 ways in which time values are handled in R.</p>
4007 <p>R makes an effort to treat a time value as a real time instance. This
4008 is in contrast with either SPSS or Stata, where time value
4009 representations such as &#8220;Sep-23-2013 14:57:21&#8221; are allowed; note that
4010 in the absence of an explicitly defined time zone, this value cannot
4011 be mapped to an exact point in real time. R handles times in the
4012 &#8220;Unix-style&#8221; way: the value is converted to the
4013 &#8220;seconds-since-the-Epoch&#8221; Greenwitch time (GMT or UTC) and the
4014 resulting numeric value is stored in the data file; time zone
4015 adjustments are made in real time as needed.</p>
4016 <p>Things get ambiguous and confusing when R <strong>displays</strong> this time
4017 value: unless the time zone was explicitly defined, R will adjust the
4018 value to the current time zone. The resulting behavior is often
4019 counter-intuitive: if you create a time value, for example:</p>
4020 <blockquote>
4021 <div>timevalue&lt;-as.POSIXct(&#8220;03/19/2013 12:57:00&#8221;, format = &#8220;%m/%d/%Y %H:%M:%OS&#8221;);</div></blockquote>
4022 <p>on a computer configured for the San Francisco time zone, the value
4023 will be differently displayed on computers in different time zones;
4024 for example, as &#8220;12:57 PST&#8221; while still on the West Coast, but as
4025 &#8220;15:57 EST&#8221; in Boston.</p>
4026 <p>If it is important that the values are always displayed the same way,
4027 regardless of the current time zones, it is recommended that the time
4028 zone is explicitly defined. For example:</p>
4029 <blockquote>
4030 <div>attr(timevalue,&#8221;tzone&#8221;)&lt;-&#8220;PST&#8221;</div></blockquote>
4031 <dl class="docutils">
4032 <dt>or</dt>
4033 <dd>timevalue&lt;-as.POSIXct(&#8220;03/19/2013 12:57:00&#8221;, format = &#8220;%m/%d/%Y %H:%M:%OS&#8221;, tz=&#8221;PST&#8221;);</dd>
4034 </dl>
4035 <p>Now the value will always be displayed as &#8220;12:57 PST&#8221;, regardless of
4036 the time zone that is current for the OS ... <strong>BUT ONLY</strong> if the OS
4037 where R is installed actually understands the time zone &#8220;PST&#8221;, which
4038 is not by any means guaranteed! Otherwise, it will <strong>quietly adjust</strong>
4039 the stored GMT value to <strong>the current time zone</strong>, yet still
4040 display it with the &#8220;PST&#8221; tag attached! One way to rephrase this is
4041 that R does a fairly decent job <strong>storing</strong> time values in a
4042 non-ambiguous, platform-independent manner - but gives no guarantee that
4043 the values will be displayed in any way that is predictable or intuitive.</p>
4044 <p>In practical terms, it is recommended to use the long/descriptive
4045 forms of time zones, as they are more likely to be properly recognized
4046 on most computers. For example, &#8220;Japan&#8221; instead of &#8220;JST&#8221;. Another possible
4047 solution is to explicitly use GMT or UTC (since it is very likely to be
4048 properly recognized on any system), or the &#8220;UTC+&lt;OFFSET&gt;&#8221; notation. Still, none of the above
4049 <strong>guarantees</strong> proper, non-ambiguous handling of time values in R data
4050 sets. The fact that R <strong>quietly</strong> modifies time values when it doesn&#8217;t
4051 recognize the supplied timezone attribute, yet still appends it to the
4052 <strong>changed</strong> time value does make it quite difficult. (These issues are
4053 discussed in depth on R-related forums, and no attempt is made to
4054 summarize it all in any depth here; this is just to made you aware of
4055 this being a potentially complex issue!)</p>
4056 <p>An important thing to keep in mind, in connection with the DVN ingest
4057 of R files, is that it will <strong>reject</strong> an R data file with any time
4058 values that have time zones that we can&#8217;t recognize. This is done in
4059 order to avoid (some) of the potential issues outlined above.</p>
4060 <p>It is also recommended that any vectors containing time values
4061 ingested into the DVN are reviewed, and the resulting entries in the
4062 TAB files are compared against the original values in the R data
4063 frame, to make sure they have been ingested as expected.</p>
4064 <p>Another <strong>potential issue</strong> here is the <strong>UNF</strong>. The way the UNF
4065 algorithm works, the same date/time values with and without the
4066 timezone (e.g. &#8220;12:45&#8221; vs. &#8220;12:45 EST&#8221;) <strong>produce different
4067 UNFs</strong>. Considering that time values in Stata/SPSS do not have time
4068 zones, but ALL time values in R do (yes, they all do - if the timezone
4069 wasn&#8217;t defined explicitely, it implicitly becomes a time value in the
4070 &#8220;UTC&#8221; zone!), this means that it is <strong>impossible</strong> to have 2 time
4071 value vectors, in Stata/SPSS and R, that produce the same UNF.</p>
4072 <p><strong>A pro tip:</strong> if it is important to produce SPSS/Stata and R versions of
4073 the same data set that result in the same UNF when ingested, you may
4074 define the time variables as <strong>strings</strong> in the R data frame, and use
4075 the &#8220;YYYY-MM-DD HH:mm:ss&#8221; formatting notation. This is the formatting used by the UNF
4076 algorithm to normalize time values, so doing the above will result in
4077 the same UNF as the vector of the same time values in Stata.</p>
4078 <p>Note: date values (dates only, without time) should be handled the
4079 exact same way as those in SPSS and Stata, and should produce the same
4080 UNFs.</p>
4081 </div>
4082 </div>
4083 <div class="section" id="fits-file-format-ingest">
4084 <span id="fits-datafile-ingest"></span><h3>FITS File format Ingest<a class="headerlink" href="#fits-file-format-ingest" title="Permalink to this headline">¶</a></h3>
4085 <p>This custom ingest is an experiment in branching out into a discipline
4086 outside of the Social Sciences. It has been added in v.3.4 as part of the
4087 collaboration between the IQSS and the Harvard-Smithsonian Center for
4088 Astrophysics. FITS is a multi-part file format for storing
4089 Astronomical data (<a class="reference external" href="http://fits.gsfc.nasa.gov/fits_standard.html">http://fits.gsfc.nasa.gov/fits_standard.html</a>). DVN
4090 now offers an ingest plugin that parses FITS file headers for
4091 key-value metadata that are extracted and made searchable.</p>
4092 <p>FITS is now listed on the DVN AddFiles page as a recognized file
4093 format. The same asynchronous process is used as for &#8220;subsettable&#8221;
4094 files: the processing is done in the background, with an email
4095 notification sent once completed.</p>
4096 <p>Unlike with the &#8220;subsettable&#8221; file ingest, no format conversion takes
4097 place and the FITS file is ingested as is, similarly to &#8220;other
4098 materials&#8221; files. The process is limited to the extaction of the
4099 searchable metadata. Once the file is ingested and the study is
4100 re-indexed, these file-level FITS metadata fields can be searched on
4101 from the Advanced Search page, on either the Dataverse or Network
4102 level. Choose one of the FITS file Information listed in the drop
4103 down, and enter the relevant search term. Search results that match
4104 the query will show individual files as well as studies.</p>
4105 <p>The ingest also generates a short summary of the file contents (number
4106 and type of Header-Data Units) and adds it to the file description.</p>
4107 </div>
4108 <div class="section" id="metadata-references">
4109 <span id="id27"></span><h3>Metadata References<a class="headerlink" href="#metadata-references" title="Permalink to this headline">¶</a></h3>
4110 <p>The Dataverse Network metadata is compliant with the <a class="reference external" href="http://www.icpsr.umich.edu/DDI/">DDI schema
4111 version 2</a>. The Cataloging
4112 Information fields associated with each study contain most of the fields
4113 in the study description section of the DDI. That way the Dataverse
4114 Network metadata can be mapped easily to a DDI, and be exported into XML
4115 format for preservation and interoperability.</p>
4116 <p>Dataverse Network data also is compliant with <a class="reference external" href="http://www.dublincore.org/">Simple Dublin
4117 Core</a>&nbsp;(DC) requirements. For imports
4118 only, Dataverse Network data is compliant with the <a class="reference external" href="http://www.fgdc.gov/metadata">Content Standard
4119 for Digital Geospatial Metadata (CSDGM), Vers. 2 (FGDC-STD-001-1998)</a>&nbsp;(FGDC).</p>
4120 <p>Attached is a PDF file that defines and maps all Dataverse Network
4121 Cataloging Information fields. Information provided in the file includes
4122 the following:</p>
4123 <ul class="simple">
4124 <li>Field label - For each Cataloging Information field, the field label
4125 appears first in the mapping matrix.</li>
4126 <li>Description - A description of each field follows the field label.</li>
4127 <li>Query term - If a field is available for use in building a query, the
4128 term to use for that field is listed.</li>
4129 <li>Dataverse Network database element name - The Dataverse Network
4130 database element name for the field is provided.</li>
4131 <li>Advanced search - If a field is available for use in an advanced
4132 search, that is indicated.</li>
4133 <li>DDI element mapping for imports - For harvested or imported studies,
4134 the imported DDI elements are mapped to Dataverse Network fields.</li>
4135 <li>DDI element mapping for exports - When a study or dataverse is
4136 harvested or exported in DDI format, the Dataverse Network fields are
4137 mapped to DDI elements.</li>
4138 <li>DC element mapping for imports - For harvested or imported studies,
4139 the imported DC elements are mapped to specific Dataverse Network
4140 fields.</li>
4141 <li>DC element mapping for exports - When a study or dataverse is
4142 harvested or exported in DC format, specific Dataverse Network fields
4143 are mapped to the DC elements.</li>
4144 <li>FGDC element mapping for imports - For harvested or imported studies,
4145 the imported FGDC elements are mapped to specific Dataverse Network fields.</li>
4146 </ul>
4147 <p>Also attached is an example of a DDI for a simple study containing
4148 title, author, description, keyword, and topic classification cataloging
4149 information fields suitable for use with batch import.</p>
4150 <p><img alt="image9" src="_images/application-pdf.png" />
4151 <a class="reference external" href="https://github.com/IQSS/dvn/blob/develop/doc/sphinx/source/datausers-guides_files/catalogingfields11apr08.pdf">catalogingfields11apr08.pdf</a></p>
4152 <p><img alt="image10" src="_images/application-octet-stream.png" />
4153 <a class="reference external" href="https://github.com/IQSS/dvn/blob/develop/doc/sphinx/source/datausers-guides_files/simple_study_1.xml">simple_study.xml</a></p>
4154 </div>
4155 <div class="section" id="zelig-interface">
4156 <h3>Zelig Interface<a class="headerlink" href="#zelig-interface" title="Permalink to this headline">¶</a></h3>
4157 <p>Zelig is statistical software for everyone: researchers, instructors,
4158 and students. It is a front-end and back-end for R (Zelig is written in
4159 R). The Zellig software:</p>
4160 <ul class="simple">
4161 <li>Unifies diverse theories of inference</li>
4162 <li>Unifies different statistical models and notation</li>
4163 <li>Unifies R packages in a common syntax</li>
4164 </ul>
4165 <p>Zelig is distributed under the GNU General Public License, Version 2.
4166 After installation, the source code is located in your R library
4167 directory. You can download a tarball of the latest Zelig source code
4168 from&nbsp;<a class="reference external" href="http://projects.iq.harvard.edu/zelig">http://projects.iq.harvard.edu/zelig</a>.</p>
4169 <p>The Dataverse Network software uses Zelig to perform advanced
4170 statistical analysis functions. The current interface schema used by the
4171 Dataverse Network for Zelig processes is in the following location:</p>
4172 <p><strong>Criteria for Model Availability</strong></p>
4173 <p>Three factors determine which Zelig models are available for analysis in
4174 the Dataverse Network:</p>
4175 <ul class="simple">
4176 <li>Some new models require data structures and modeling parameters that
4177 are not compatible with the current framework of the Dataverse Network
4178 and other web-driven applications. These types of models are not
4179 available in the Dataverse Network.</li>
4180 <li>Models must be explicitly listed in the Zelig packages to be used in
4181 the Dataverse Network, and all models must be disclosed fully, including
4182 runtime errors. Zelig models that do not meet these specifications are
4183 excluded from the Dataverse Network until they are disclosed with a
4184 complete set of information.</li>
4185 <li>An installation-based factor also can limit the Zelig models available
4186 in the Dataverse Network. A minimum version of the core software package
4187 GCC 4.0 must be installed on any Linux OS-based R machine used with the
4188 Dataverse Network, to install and run a key Zelig package, MCMCpack. If
4189 a Linux machine that is designated to R is used for DSB services and
4190 does not have the minimum version of the GCC package installed, the
4191 Dataverse Network looses at least eight models from the available
4192 advanced analysis models.</li>
4193 </ul>
4194 <p><img alt="image11" src="_images/application-octet-stream.png" />
4195 <a class="reference external" href="https://github.com/IQSS/dvn/blob/develop/doc/sphinx/source/datausers-guides_files/configzeliggui_0.xml">configzeliggui.xml</a></p>
4196 </div>
4197 </div>
4198 </div>
4199
4200
4201 </div>
4202 </div>
4203 </div>
4204 </div>
4205 <div class="sidebar">
4206 <h3>Table Of Contents</h3>
4207 <ul class="current">
4208 <li class="toctree-l1 current"><a class="current reference internal" href="">User Guide</a><ul>
4209 <li class="toctree-l2"><a class="reference internal" href="#common-tasks">Common Tasks</a><ul>
4210 <li class="toctree-l3"><a class="reference internal" href="#finding-data">Finding Data</a></li>
4211 <li class="toctree-l3"><a class="reference internal" href="#using-data">Using Data</a></li>
4212 <li class="toctree-l3"><a class="reference internal" href="#publishing-data">Publishing Data</a></li>
4213 <li class="toctree-l3"><a class="reference internal" href="#things-to-consider-next-steps">Things to Consider, Next Steps</a></li>
4214 <li class="toctree-l3"><a class="reference internal" href="#how-the-guides-are-organized">How the Guides Are Organized</a></li>
4215 <li class="toctree-l3"><a class="reference internal" href="#other-resources">Other Resources</a></li>
4216 <li class="toctree-l3"><a class="reference internal" href="#contact-us">Contact Us</a></li>
4217 </ul>
4218 </li>
4219 <li class="toctree-l2"><a class="reference internal" href="#finding-and-using-data">Finding and Using Data</a><ul>
4220 <li class="toctree-l3"><a class="reference internal" href="#search">Search</a></li>
4221 <li class="toctree-l3"><a class="reference internal" href="#view-studies-download-data">View Studies / Download Data</a></li>
4222 <li class="toctree-l3"><a class="reference internal" href="#subset-and-analysis">Subset and Analysis</a><ul>
4223 <li class="toctree-l4"><a class="reference internal" href="#tabular-data">Tabular Data</a></li>
4224 <li class="toctree-l4"><a class="reference internal" href="#network-data">Network Data</a></li>
4225 </ul>
4226 </li>
4227 <li class="toctree-l3"><a class="reference internal" href="#data-visualization">Data Visualization</a><ul>
4228 <li class="toctree-l4"><a class="reference internal" href="#explore-data">Explore Data</a></li>
4229 <li class="toctree-l4"><a class="reference internal" href="#set-up">Set Up</a></li>
4230 </ul>
4231 </li>
4232 </ul>
4233 </li>
4234 <li class="toctree-l2"><a class="reference internal" href="#dataverse-administration">Dataverse Administration</a><ul>
4235 <li class="toctree-l3"><a class="reference internal" href="#create-a-dataverse">Create a Dataverse</a></li>
4236 <li class="toctree-l3"><a class="reference internal" href="#edit-general-settings">Edit General Settings</a></li>
4237 <li class="toctree-l3"><a class="reference internal" href="#edit-layout-branding">Edit Layout Branding</a></li>
4238 <li class="toctree-l3"><a class="reference internal" href="#edit-description">Edit Description</a></li>
4239 <li class="toctree-l3"><a class="reference internal" href="#edit-study-comments-settings">Edit Study Comments Settings</a></li>
4240 <li class="toctree-l3"><a class="reference internal" href="#manage-e-mail-notifications">Manage E-Mail Notifications</a></li>
4241 <li class="toctree-l3"><a class="reference internal" href="#add-fields-to-search-results">Add Fields to Search Results</a></li>
4242 <li class="toctree-l3"><a class="reference internal" href="#set-default-study-listing-sort-order">Set Default Study Listing Sort Order</a></li>
4243 <li class="toctree-l3"><a class="reference internal" href="#enable-twitter">Enable Twitter</a></li>
4244 <li class="toctree-l3"><a class="reference internal" href="#get-code-for-dataverse-link-or-search-box">Get Code for Dataverse Link or Search Box</a></li>
4245 <li class="toctree-l3"><a class="reference internal" href="#edit-terms-for-study-creation">Edit Terms for Study Creation</a></li>
4246 <li class="toctree-l3"><a class="reference internal" href="#edit-terms-for-file-download">Edit Terms for File Download</a></li>
4247 <li class="toctree-l3"><a class="reference internal" href="#manage-permissions">Manage Permissions</a></li>
4248 <li class="toctree-l3"><a class="reference internal" href="#create-user-account">Create User Account</a></li>
4249 <li class="toctree-l3"><a class="reference internal" href="#download-tracking-data">Download Tracking Data</a></li>
4250 <li class="toctree-l3"><a class="reference internal" href="#edit-file-download-guestbook">Edit File Download Guestbook</a></li>
4251 <li class="toctree-l3"><a class="reference internal" href="#openscholar">OpenScholar</a></li>
4252 <li class="toctree-l3"><a class="reference internal" href="#enabling-lockss-access-to-the-dataverse">Enabling LOCKSS access to the Dataverse</a></li>
4253 </ul>
4254 </li>
4255 <li class="toctree-l2"><a class="reference internal" href="#study-and-data-administration">Study and Data Administration</a><ul>
4256 <li class="toctree-l3"><a class="reference internal" href="#create-new-study">Create New Study</a></li>
4257 <li class="toctree-l3"><a class="reference internal" href="#manage-studies">Manage Studies</a></li>
4258 <li class="toctree-l3"><a class="reference internal" href="#manage-study-templates">Manage Study Templates</a></li>
4259 <li class="toctree-l3"><a class="reference internal" href="#data-uploads">Data Uploads</a></li>
4260 <li class="toctree-l3"><a class="reference internal" href="#manage-collections">Manage Collections</a></li>
4261 <li class="toctree-l3"><a class="reference internal" href="#managing-user-file-access">Managing User File Access</a></li>
4262 </ul>
4263 </li>
4264 <li class="toctree-l2"><a class="reference internal" href="#network-administration">Network Administration</a><ul>
4265 <li class="toctree-l3"><a class="reference internal" href="#dataverses-section">Dataverses Section</a><ul>
4266 <li class="toctree-l4"><a class="reference internal" href="#create-a-new-dataverse">Create a New Dataverse</a></li>
4267 <li class="toctree-l4"><a class="reference internal" href="#manage-dataverses">Manage Dataverses</a></li>
4268 </ul>
4269 </li>
4270 <li class="toctree-l3"><a class="reference internal" href="#subnetwork-section">Subnetwork Section</a><ul>
4271 <li class="toctree-l4"><a class="reference internal" href="#create-a-new-subnetwork">Create a New Subnetwork</a></li>
4272 <li class="toctree-l4"><a class="reference internal" href="#manage-subnetworks">Manage Subnetworks</a></li>
4273 <li class="toctree-l4"><a class="reference internal" href="#manage-classifications">Manage Classifications</a></li>
4274 <li class="toctree-l4"><a class="reference internal" href="#manage-study-comments-notifications">Manage Study Comments Notifications</a></li>
4275 <li class="toctree-l4"><a class="reference internal" href="#manage-controlled-vocabulary">Manage Controlled Vocabulary</a></li>
4276 <li class="toctree-l4"><a class="reference internal" href="#manage-network-study-templates">Manage Network Study Templates</a></li>
4277 </ul>
4278 </li>
4279 <li class="toctree-l3"><a class="reference internal" href="#harvesting-section">Harvesting Section</a><ul>
4280 <li class="toctree-l4"><a class="reference internal" href="#create-a-new-harvesting-dataverse">Create a New Harvesting Dataverse</a></li>
4281 <li class="toctree-l4"><a class="reference internal" href="#manage-harvesting">Manage Harvesting</a></li>
4282 <li class="toctree-l4"><a class="reference internal" href="#schedule-study-exports">Schedule Study Exports</a></li>
4283 <li class="toctree-l4"><a class="reference internal" href="#manage-oai-harvesting-sets">Manage OAI Harvesting Sets</a></li>
4284 <li class="toctree-l4"><a class="reference internal" href="#edit-lockss-harvest-settings">Edit LOCKSS Harvest Settings</a></li>
4285 </ul>
4286 </li>
4287 <li class="toctree-l3"><a class="reference internal" href="#settings-section">Settings Section</a><ul>
4288 <li class="toctree-l4"><a class="reference internal" href="#edit-name">Edit Name</a></li>
4289 <li class="toctree-l4"><a class="reference internal" href="#id10">Edit Layout Branding</a></li>
4290 <li class="toctree-l4"><a class="reference internal" href="#id11">Edit Description</a></li>
4291 <li class="toctree-l4"><a class="reference internal" href="#edit-dataverse-requirements">Edit Dataverse Requirements</a></li>
4292 <li class="toctree-l4"><a class="reference internal" href="#id12">Manage E-Mail Notifications</a></li>
4293 <li class="toctree-l4"><a class="reference internal" href="#id13">Enable Twitter</a></li>
4294 </ul>
4295 </li>
4296 <li class="toctree-l3"><a class="reference internal" href="#terms-section">Terms Section</a><ul>
4297 <li class="toctree-l4"><a class="reference internal" href="#edit-terms-for-account-creation">Edit Terms for Account Creation</a></li>
4298 <li class="toctree-l4"><a class="reference internal" href="#id14">Edit Terms for Study Creation</a></li>
4299 <li class="toctree-l4"><a class="reference internal" href="#id15">Edit Terms for File Download</a></li>
4300 <li class="toctree-l4"><a class="reference internal" href="#id16">Download Tracking Data</a></li>
4301 </ul>
4302 </li>
4303 <li class="toctree-l3"><a class="reference internal" href="#permissions-and-users-section">Permissions and Users Section</a><ul>
4304 <li class="toctree-l4"><a class="reference internal" href="#manage-network-permissions">Manage Network Permissions</a></li>
4305 <li class="toctree-l4"><a class="reference internal" href="#roles-by-version-state-table">Roles by Version State Table</a></li>
4306 <li class="toctree-l4"><a class="reference internal" href="#authorization-to-access-terms-protected-files-via-the-api">Authorization to access Terms-protected files via the API</a></li>
4307 <li class="toctree-l4"><a class="reference internal" href="#create-account">Create Account</a></li>
4308 <li class="toctree-l4"><a class="reference internal" href="#manage-users">Manage Users</a></li>
4309 <li class="toctree-l4"><a class="reference internal" href="#manage-groups">Manage Groups</a></li>
4310 </ul>
4311 </li>
4312 <li class="toctree-l3"><a class="reference internal" href="#utilities">Utilities</a></li>
4313 <li class="toctree-l3"><a class="reference internal" href="#web-statistics">Web Statistics</a></li>
4314 </ul>
4315 </li>
4316 <li class="toctree-l2"><a class="reference internal" href="#appendix">Appendix</a><ul>
4317 <li class="toctree-l3"><a class="reference internal" href="#control-card-based-data-ingest">Control Card-Based Data Ingest</a><ul>
4318 <li class="toctree-l4"><a class="reference internal" href="#csv-data-spss-style-control-card">CSV Data, SPSS-style Control Card</a></li>
4319 <li class="toctree-l4"><a class="reference internal" href="#tab-data-with-ddi-metadata">Tab Data, with DDI Metadata</a></li>
4320 </ul>
4321 </li>
4322 <li class="toctree-l3"><a class="reference internal" href="#spss-data-file-ingest">SPSS Data File Ingest</a><ul>
4323 <li class="toctree-l4"><a class="reference internal" href="#ingesting-spss-por-files-with-extended-labels">Ingesting SPSS (.por) files with extended labels</a></li>
4324 </ul>
4325 </li>
4326 <li class="toctree-l3"><a class="reference internal" href="#ingest-of-r-rdata-files">Ingest of R (.RData) files</a><ul>
4327 <li class="toctree-l4"><a class="reference internal" href="#overview">Overview.</a></li>
4328 <li class="toctree-l4"><a class="reference internal" href="#requirements">Requirements.</a></li>
4329 <li class="toctree-l4"><a class="reference internal" href="#data-types-compared-to-other-supported-formats-stat-spss">Data Types, compared to other supported formats (Stat, SPSS)</a><ul>
4330 <li class="toctree-l5"><a class="reference internal" href="#integers-doubles-character-strings">Integers, Doubles, Character strings</a></li>
4331 <li class="toctree-l5"><a class="reference internal" href="#r-factors">R Factors</a></li>
4332 <li class="toctree-l5"><a class="reference internal" href="#new-boolean-values">(New!) Boolean values</a></li>
4333 <li class="toctree-l5"><a class="reference internal" href="#limitations-of-r-data-format-as-compared-to-spss-and-stata">Limitations of R data format, as compared to SPSS and STATA.</a></li>
4334 </ul>
4335 </li>
4336 <li class="toctree-l4"><a class="reference internal" href="#time-values-in-r">Time values in R</a></li>
4337 </ul>
4338 </li>
4339 <li class="toctree-l3"><a class="reference internal" href="#fits-file-format-ingest">FITS File format Ingest</a></li>
4340 <li class="toctree-l3"><a class="reference internal" href="#metadata-references">Metadata References</a></li>
4341 <li class="toctree-l3"><a class="reference internal" href="#zelig-interface">Zelig Interface</a></li>
4342 </ul>
4343 </li>
4344 </ul>
4345 </li>
4346 <li class="toctree-l1"><a class="reference internal" href="dataverse-installer-main.html">Installers Guide</a></li>
4347 <li class="toctree-l1"><a class="reference internal" href="dataverse-developer-main.html">DVN Developers Guide</a></li>
4348 <li class="toctree-l1"><a class="reference internal" href="dataverse-api-main.html">APIs Guide</a></li>
4349 </ul>
4350
4351 <h3 style="margin-top: 1.5em;">Search</h3>
4352 <form class="search" action="search.html" method="get">
4353 <input type="text" name="q" />
4354 <input type="submit" value="Go" />
4355 <input type="hidden" name="check_keywords" value="yes" />
4356 <input type="hidden" name="area" value="default" />
4357 </form>
4358 <p class="searchtip" style="font-size: 90%">
4359 Enter search terms.
4360 </p>
4361 </div>
4362 <div class="clearer"></div>
4363 </div>
4364 </div>
4365
4366 <div class="footer-wrapper">
4367 <div class="footer">
4368 <div class="left">
4369 <a href="index.html" title="Dataverse Network Guides"
4370 >previous</a> |
4371 <a href="dataverse-installer-main.html" title="Installers Guide"
4372 >next</a> |
4373 <a href="genindex.html" title="General Index"
4374 >index</a>
4375 <br/>
4376 <a href="_sources/dataverse-user-main.txt"
4377 rel="nofollow">Show Source</a>
4378 </div>
4379
4380 <div class="right">
4381
4382 <div class="footer">
4383 &copy; Copyright 1997-2013, President &amp; Fellows Harvard University.
4384 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
4385 </div>
4386 </div>
4387 <div class="clearer"></div>
4388 </div>
4389 </div>
4390
4391 </body>
4392 </html>