Skip to content

Commit cbd047d

Browse files
committed
maggieklope published a site update
1 parent 505b674 commit cbd047d

File tree

4 files changed

+54
-42
lines changed

4 files changed

+54
-42
lines changed

reference/final-checklist.html

+26-20
Original file line numberDiff line numberDiff line change
@@ -443,64 +443,69 @@ <h3>System Metadata<a href="final-checklist.html#system-metadata" class="anchor-
443443
</div>
444444
<div id="general-eml" class="section level3 hasAnchor">
445445
<h3>General EML<a href="final-checklist.html#general-eml" class="anchor-section" aria-label="Anchor link to header"></a></h3>
446-
<p>Included lines for FAIR:</p>
446+
<ul>
447+
<li>Ethical Research Practice section is completed</li>
448+
<li>Publisher and system information have been added:</li>
449+
</ul>
447450
<div class="sourceCode" id="cb158"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb158-1"><a href="final-checklist.html#cb158-1" tabindex="-1"></a>doc <span class="ot">&lt;-</span> <span class="fu">eml_add_publisher</span>(doc)</span>
448451
<span id="cb158-2"><a href="final-checklist.html#cb158-2" tabindex="-1"></a>doc <span class="ot">&lt;-</span> <span class="fu">eml_add_entity_system</span>(doc)</span></code></pre></div>
449452
</div>
450453
<div id="title-1" class="section level3 hasAnchor">
451454
<h3>Title<a href="final-checklist.html#title-1" class="anchor-section" aria-label="Anchor link to header"></a></h3>
452455
<ul>
453-
<li>No abbreviations, should include geographic and temporal coverage</li>
456+
<li>Include geographic and temporal coverage (when and where data was collected)</li>
457+
<li>Abbreviations are removed or defined</li>
454458
</ul>
455459
</div>
456460
<div id="abstract-1" class="section level3 hasAnchor">
457461
<h3>Abstract<a href="final-checklist.html#abstract-1" class="anchor-section" aria-label="Anchor link to header"></a></h3>
458462
<ul>
459463
<li>longer than 100 words</li>
460-
<li>no abbreviations or garbled text</li>
461-
<li>tags such as <code>&lt;superscript&gt;2&lt;/superscript&gt;</code> and <code>&lt;subscript&gt;2&lt;/subscript&gt;</code> can be used for nicer formatting</li>
464+
<li>Abbreviations are removed or defined. No garbled text</li>
465+
<li>Tags such as <code>&lt;superscript&gt;2&lt;/superscript&gt;</code> and <code>&lt;subscript&gt;2&lt;/subscript&gt;</code> can be used for nicer formatting</li>
462466
</ul>
463467
</div>
464468
<div id="datatable-otherentity-spatialvectors" class="section level3 hasAnchor">
465469
<h3>DataTable / OtherEntity / SpatialVectors<a href="final-checklist.html#datatable-otherentity-spatialvectors" class="anchor-section" aria-label="Anchor link to header"></a></h3>
466470
<ul>
467-
<li>in the correct one: <strong>DataTable / OtherEntity / SpatialVector / SpatialRaster</strong> for the file type</li>
471+
<li>In the correct one: <strong>DataTable / OtherEntity / SpatialVector / SpatialRaster</strong> for the file type</li>
468472
<li><strong>entityDescription</strong> - longer than 5 words and unique</li>
469-
<li><strong>physical</strong> present and format correct</li>
473+
<li><strong>physical</strong> present and up-to-date and format is correct</li>
470474
</ul>
471475
<div id="attribute-table" class="section level4 hasAnchor">
472476
<h4>Attribute Table<a href="final-checklist.html#attribute-table" class="anchor-section" aria-label="Anchor link to header"></a></h4>
473477
<ul>
474-
<li>complete</li>
478+
<li>Complete</li>
475479
<li>attributeDefinitions longer than 3 words</li>
476480
<li><strong>Variables</strong> match what is in the file</li>
477481
<li><strong>Measurement domain</strong> - if appropirate (ie dateTime correct)</li>
478482
<li><strong>Missing Value Code</strong> - accounted for if applicable</li>
479483
<li><strong>Semantic Annotation</strong> - appropriate semantic annotations added, especially for spatial and temporal variables: lat, lon, date etc.</li>
484+
<li>Custom units were created if necessary</li>
480485
</ul>
481486
</div>
482487
</div>
483488
<div id="people" class="section level3 hasAnchor">
484489
<h3>People<a href="final-checklist.html#people" class="anchor-section" aria-label="Anchor link to header"></a></h3>
485490
<ul>
486-
<li>complete information for each person in each section
491+
<li>Complete information for each person in each section
487492
<ul>
488-
<li>including ORCID and e-mail address for all contacts</li>
489-
<li>people repeated across sections should have consistent information</li>
493+
<li>includes ORCID and e-mail address for all contacts</li>
494+
<li>people repeated across sections have consistent information</li>
490495
</ul></li>
491496
</ul>
492497
</div>
493498
<div id="geographic-region" class="section level3 hasAnchor">
494499
<h3>Geographic region<a href="final-checklist.html#geographic-region" class="anchor-section" aria-label="Anchor link to header"></a></h3>
495500
<ul>
496-
<li>the map looks correctand matches the geographic description</li>
501+
<li>the map looks correct and matches the geographic description</li>
497502
<li>check if negatives (-) are missing</li>
498503
</ul>
499504
</div>
500505
<div id="project" class="section level3 hasAnchor">
501506
<h3>Project<a href="final-checklist.html#project" class="anchor-section" aria-label="Anchor link to header"></a></h3>
502507
<ul>
503-
<li>if it is an NSF award you can use the helper function:
508+
<li>If it is an NSF award you can use the helper function:
504509
<ul>
505510
<li><code>doc$dataset$project &lt;- eml_nsf_to_project(awards)</code></li>
506511
</ul></li>
@@ -510,23 +515,24 @@ <h3>Project<a href="final-checklist.html#project" class="anchor-section" aria-la
510515
<div id="methods-1" class="section level3 hasAnchor">
511516
<h3>Methods<a href="final-checklist.html#methods-1" class="anchor-section" aria-label="Anchor link to header"></a></h3>
512517
<ul>
513-
<li>present</li>
514-
<li>no garbled text</li>
518+
<li>Present</li>
519+
<li>No garbled text</li>
520+
<li>Acronyms and units are defined the first time they are used</li>
515521
</ul>
516522
</div>
517523
<div id="check-eml-version" class="section level3 hasAnchor">
518524
<h3>Check EML Version<a href="final-checklist.html#check-eml-version" class="anchor-section" aria-label="Anchor link to header"></a></h3>
519525
<ul>
520-
<li>currently using: <code>eml-2.2.0</code> (as of July 30 2020)</li>
521-
<li>review to see if the EML version is set correctly by reviewing the <code>doc$`@context`</code> that it is indeed 2.2.0 under eml</li>
526+
<li>Currently using: <code>eml-2.2.0</code> (as of July 30 2020)</li>
527+
<li>Review to see if the EML version is set correctly by reviewing the <code>doc$`@context`</code> that it is indeed 2.2.0 under eml</li>
522528
<li>Re-run your code again and have the line<code>emld::eml_version("eml-2.2.0")</code> at the top</li>
523529
<li>Make sure the system metadata is also 2.2.0</li>
524530
</ul>
525531
</div>
526532
<div id="access-1" class="section level3 hasAnchor">
527533
<h3>Access<a href="final-checklist.html#access-1" class="anchor-section" aria-label="Anchor link to header"></a></h3>
528534
<ul>
529-
<li>Granted access to PI using <code>set_rights_and_access()</code>
535+
<li>If necessary, granted access to PI using <code>set_rights_and_access()</code>
530536
<ul>
531537
<li>make sure it is <code>http://</code> (no s)</li>
532538
</ul></li>
@@ -536,7 +542,7 @@ <h3>Access<a href="final-checklist.html#access-1" class="anchor-section" aria-la
536542
<div id="sftp-files" class="section level3 hasAnchor">
537543
<h3>SFTP Files<a href="final-checklist.html#sftp-files" class="anchor-section" aria-label="Anchor link to header"></a></h3>
538544
<ul>
539-
<li>if there are files transferred to us via SFTP, delete those files when the ticket is resolved</li>
545+
<li>If there are files transferred to us via SFTP, delete those files once they have been added to the dataset and when the ticket is resolved</li>
540546
</ul>
541547
</div>
542548
<div id="updated-datasets" class="section level3 hasAnchor">
@@ -546,7 +552,7 @@ <h3>Updated datasets<a href="final-checklist.html#updated-datasets" class="ancho
546552
<li>New data was added
547553
<ul>
548554
<li>Temporal Coverage and Title</li>
549-
<li>and follow usual protocols</li>
555+
<li>Confirm if new data used same methods or if methods need updating</li>
550556
</ul></li>
551557
<li>Files were replaced
552558
<ul>
@@ -556,7 +562,7 @@ <h3>Updated datasets<a href="final-checklist.html#updated-datasets" class="ancho
556562
</ul></li>
557563
<li>Was the dataset published before 2021?
558564
<ul>
559-
<li>update project info , annotations</li>
565+
<li>update project info, annotations</li>
560566
</ul></li>
561567
<li>Glance over entire page for any small mistakes (ie. repeated additionalMetadata, any missed &amp;amps, typos)</li>
562568
</ul>

reference/search_index.json

+1-1
Large diffs are not rendered by default.

training/first-ticket.html

+26-20
Original file line numberDiff line numberDiff line change
@@ -607,64 +607,69 @@ <h3><span class="header-section-number">9.4.2</span> System Metadata<a href="fir
607607
</div>
608608
<div id="general-eml" class="section level3 hasAnchor" number="9.4.3">
609609
<h3><span class="header-section-number">9.4.3</span> General EML<a href="first-ticket.html#general-eml" class="anchor-section" aria-label="Anchor link to header"></a></h3>
610-
<p>Included lines for FAIR:</p>
610+
<ul>
611+
<li>Ethical Research Practice section is completed</li>
612+
<li>Publisher and system information have been added:</li>
613+
</ul>
611614
<div class="sourceCode" id="cb121"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb121-1"><a href="first-ticket.html#cb121-1" tabindex="-1"></a>doc <span class="ot">&lt;-</span> <span class="fu">eml_add_publisher</span>(doc)</span>
612615
<span id="cb121-2"><a href="first-ticket.html#cb121-2" tabindex="-1"></a>doc <span class="ot">&lt;-</span> <span class="fu">eml_add_entity_system</span>(doc)</span></code></pre></div>
613616
</div>
614617
<div id="title-1" class="section level3 hasAnchor" number="9.4.4">
615618
<h3><span class="header-section-number">9.4.4</span> Title<a href="first-ticket.html#title-1" class="anchor-section" aria-label="Anchor link to header"></a></h3>
616619
<ul>
617-
<li>No abbreviations, should include geographic and temporal coverage</li>
620+
<li>Include geographic and temporal coverage (when and where data was collected)</li>
621+
<li>Abbreviations are removed or defined</li>
618622
</ul>
619623
</div>
620624
<div id="abstract-1" class="section level3 hasAnchor" number="9.4.5">
621625
<h3><span class="header-section-number">9.4.5</span> Abstract<a href="first-ticket.html#abstract-1" class="anchor-section" aria-label="Anchor link to header"></a></h3>
622626
<ul>
623627
<li>longer than 100 words</li>
624-
<li>no abbreviations or garbled text</li>
625-
<li>tags such as <code>&lt;superscript&gt;2&lt;/superscript&gt;</code> and <code>&lt;subscript&gt;2&lt;/subscript&gt;</code> can be used for nicer formatting</li>
628+
<li>Abbreviations are removed or defined. No garbled text</li>
629+
<li>Tags such as <code>&lt;superscript&gt;2&lt;/superscript&gt;</code> and <code>&lt;subscript&gt;2&lt;/subscript&gt;</code> can be used for nicer formatting</li>
626630
</ul>
627631
</div>
628632
<div id="datatable-otherentity-spatialvectors" class="section level3 hasAnchor" number="9.4.6">
629633
<h3><span class="header-section-number">9.4.6</span> DataTable / OtherEntity / SpatialVectors<a href="first-ticket.html#datatable-otherentity-spatialvectors" class="anchor-section" aria-label="Anchor link to header"></a></h3>
630634
<ul>
631-
<li>in the correct one: <strong>DataTable / OtherEntity / SpatialVector / SpatialRaster</strong> for the file type</li>
635+
<li>In the correct one: <strong>DataTable / OtherEntity / SpatialVector / SpatialRaster</strong> for the file type</li>
632636
<li><strong>entityDescription</strong> - longer than 5 words and unique</li>
633-
<li><strong>physical</strong> present and format correct</li>
637+
<li><strong>physical</strong> present and up-to-date and format is correct</li>
634638
</ul>
635639
<div id="attribute-table" class="section level4 hasAnchor" number="9.4.6.1">
636640
<h4><span class="header-section-number">9.4.6.1</span> Attribute Table<a href="first-ticket.html#attribute-table" class="anchor-section" aria-label="Anchor link to header"></a></h4>
637641
<ul>
638-
<li>complete</li>
642+
<li>Complete</li>
639643
<li>attributeDefinitions longer than 3 words</li>
640644
<li><strong>Variables</strong> match what is in the file</li>
641645
<li><strong>Measurement domain</strong> - if appropirate (ie dateTime correct)</li>
642646
<li><strong>Missing Value Code</strong> - accounted for if applicable</li>
643647
<li><strong>Semantic Annotation</strong> - appropriate semantic annotations added, especially for spatial and temporal variables: lat, lon, date etc.</li>
648+
<li>Custom units were created if necessary</li>
644649
</ul>
645650
</div>
646651
</div>
647652
<div id="people" class="section level3 hasAnchor" number="9.4.7">
648653
<h3><span class="header-section-number">9.4.7</span> People<a href="first-ticket.html#people" class="anchor-section" aria-label="Anchor link to header"></a></h3>
649654
<ul>
650-
<li>complete information for each person in each section
655+
<li>Complete information for each person in each section
651656
<ul>
652-
<li>including ORCID and e-mail address for all contacts</li>
653-
<li>people repeated across sections should have consistent information</li>
657+
<li>includes ORCID and e-mail address for all contacts</li>
658+
<li>people repeated across sections have consistent information</li>
654659
</ul></li>
655660
</ul>
656661
</div>
657662
<div id="geographic-region" class="section level3 hasAnchor" number="9.4.8">
658663
<h3><span class="header-section-number">9.4.8</span> Geographic region<a href="first-ticket.html#geographic-region" class="anchor-section" aria-label="Anchor link to header"></a></h3>
659664
<ul>
660-
<li>the map looks correctand matches the geographic description</li>
665+
<li>the map looks correct and matches the geographic description</li>
661666
<li>check if negatives (-) are missing</li>
662667
</ul>
663668
</div>
664669
<div id="project" class="section level3 hasAnchor" number="9.4.9">
665670
<h3><span class="header-section-number">9.4.9</span> Project<a href="first-ticket.html#project" class="anchor-section" aria-label="Anchor link to header"></a></h3>
666671
<ul>
667-
<li>if it is an NSF award you can use the helper function:
672+
<li>If it is an NSF award you can use the helper function:
668673
<ul>
669674
<li><code>doc$dataset$project &lt;- eml_nsf_to_project(awards)</code></li>
670675
</ul></li>
@@ -674,23 +679,24 @@ <h3><span class="header-section-number">9.4.9</span> Project<a href="first-ticke
674679
<div id="methods-1" class="section level3 hasAnchor" number="9.4.10">
675680
<h3><span class="header-section-number">9.4.10</span> Methods<a href="first-ticket.html#methods-1" class="anchor-section" aria-label="Anchor link to header"></a></h3>
676681
<ul>
677-
<li>present</li>
678-
<li>no garbled text</li>
682+
<li>Present</li>
683+
<li>No garbled text</li>
684+
<li>Acronyms and units are defined the first time they are used</li>
679685
</ul>
680686
</div>
681687
<div id="check-eml-version" class="section level3 hasAnchor" number="9.4.11">
682688
<h3><span class="header-section-number">9.4.11</span> Check EML Version<a href="first-ticket.html#check-eml-version" class="anchor-section" aria-label="Anchor link to header"></a></h3>
683689
<ul>
684-
<li>currently using: <code>eml-2.2.0</code> (as of July 30 2020)</li>
685-
<li>review to see if the EML version is set correctly by reviewing the <code>doc$`@context`</code> that it is indeed 2.2.0 under eml</li>
690+
<li>Currently using: <code>eml-2.2.0</code> (as of July 30 2020)</li>
691+
<li>Review to see if the EML version is set correctly by reviewing the <code>doc$`@context`</code> that it is indeed 2.2.0 under eml</li>
686692
<li>Re-run your code again and have the line<code>emld::eml_version("eml-2.2.0")</code> at the top</li>
687693
<li>Make sure the system metadata is also 2.2.0</li>
688694
</ul>
689695
</div>
690696
<div id="access" class="section level3 hasAnchor" number="9.4.12">
691697
<h3><span class="header-section-number">9.4.12</span> Access<a href="first-ticket.html#access" class="anchor-section" aria-label="Anchor link to header"></a></h3>
692698
<ul>
693-
<li>Granted access to PI using <code>set_rights_and_access()</code>
699+
<li>If necessary, granted access to PI using <code>set_rights_and_access()</code>
694700
<ul>
695701
<li>make sure it is <code>http://</code> (no s)</li>
696702
</ul></li>
@@ -700,7 +706,7 @@ <h3><span class="header-section-number">9.4.12</span> Access<a href="first-ticke
700706
<div id="sftp-files" class="section level3 hasAnchor" number="9.4.13">
701707
<h3><span class="header-section-number">9.4.13</span> SFTP Files<a href="first-ticket.html#sftp-files" class="anchor-section" aria-label="Anchor link to header"></a></h3>
702708
<ul>
703-
<li>if there are files transferred to us via SFTP, delete those files when the ticket is resolved</li>
709+
<li>If there are files transferred to us via SFTP, delete those files once they have been added to the dataset and when the ticket is resolved</li>
704710
</ul>
705711
</div>
706712
<div id="updated-datasets" class="section level3 hasAnchor" number="9.4.14">
@@ -710,7 +716,7 @@ <h3><span class="header-section-number">9.4.14</span> Updated datasets<a href="f
710716
<li>New data was added
711717
<ul>
712718
<li>Temporal Coverage and Title</li>
713-
<li>and follow usual protocols</li>
719+
<li>Confirm if new data used same methods or if methods need updating</li>
714720
</ul></li>
715721
<li>Files were replaced
716722
<ul>
@@ -720,7 +726,7 @@ <h3><span class="header-section-number">9.4.14</span> Updated datasets<a href="f
720726
</ul></li>
721727
<li>Was the dataset published before 2021?
722728
<ul>
723-
<li>update project info , annotations</li>
729+
<li>update project info, annotations</li>
724730
</ul></li>
725731
<li>Glance over entire page for any small mistakes (ie. repeated additionalMetadata, any missed &amp;amps, typos)</li>
726732
</ul>

training/search_index.json

+1-1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)