diff --git a/docs/articles/Starting-a-DRR.html b/docs/articles/Starting-a-DRR.html index 733b133..a0220b4 100644 --- a/docs/articles/Starting-a-DRR.html +++ b/docs/articles/Starting-a-DRR.html @@ -102,8 +102,7 @@

DRRs: Background

Purpose and Scope of Data Release Reports

-

This is a template is for use when drafting Data Release Reports. -DRRs are created by the National Park Service and provide detailed +

DRRs are created by the National Park Service and provide detailed descriptions of valuable research datasets, including the methods used to collect the data and technical analyses supporting the quality of the measurements. Data Release Reports focus on helping others reuse data @@ -111,19 +110,23 @@

DRRs: Background
-

About this Template +

About the DRR Template

-

This template contains an rmarkdown template file, default folder -structure for project files, and all the necessary template files to -generate an unformatted .docx file. Upon submission for publication, the -.docx file will be ingested by EXstyles, converted to an .xml file and -fully formatted according to NPS branding upon final publication. The -goal of this process is to relieve data producers, managers, and -scientists from the burden of formatting and allow them to focus -primarily on content. Consequently, the .docx generated for the -publication process may not be visually appealing. The content, however, -should focus on the production, quality, and utility of NPS data -packages.

+

Opening a new NPS DRR Template will write a folder to the current +working directory that contains the an rmarkdown (.rmd) file that is the +DRR Tempate, a references.bib file for bibtex references, a +national-park-service-DRR,csl file for formatting references, and a +sub-folder, BICY_Example with an example data package that can be used +to knit an example DRR to .docx.

+

Upon submission for publication, the .docx file will be ingested by +EXstyles, converted to an .xml file and fully formatted according to NPS +branding and in compliance with 508 accessibility requirements upon +final publication. The goal of this process is to relieve data +producers, managers, and scientists from the burden of formatting and +allow them to focus primarily on content. Consequently, the .docx +generated for the publication process may not be visually appealing. The +content, however, should focus on the production, quality, and utility +of NPS data packages.

How to Start a DRR @@ -132,11 +135,13 @@

How to Start a DRRdocumentation +associated with the R package EMLeditor +for data package creation). All of the .csv files you want to describe +in the DRR should be in a single folder with no additional .csv +files (other files such as .txt and .xml will be ignored). This +folder can be the same folder you used/are using to create a data +package.

  • Using Rstudio, open an R project (Select: File > New Project…) in the same folder as your .csv files. If you already have an R project (.Rproj) initiated from creating a data package, you @@ -166,7 +171,7 @@

    How to Start a DRR
  • Open a new DRR Template. From within Rstudio, -select the “File” drop down menu. Choose “New File” and then “R +select the “File” drop down menu. Choose “New File >” and then “R markdown…”. This will open up a pop-up dialog box. Select “From Template” on in the right-hand list and choose the template labelled “NPS_DRR {QCkit}”. You can change the file and folder name to something @@ -182,8 +187,8 @@

    How to Start a DRR“Using the DRR Template” +
  • Edit the DRR Template to reflect the data you +would like to descibe and according to the instructions in the “Using the DRR Template” guide.

  • “knit” the .rmd file to Word when you are done editing it. Submit the resulting .docx file for publication (via a @@ -194,10 +199,10 @@

    How to Start a DRRExamples

    Knit your own example DRR: Assuming you left the -“Name:” as the default “untitled”, you should be able to knit the DRR +“Name:” as the default “Untitled”, you should be able to knit the DRR template in to an example .docx that could be submitted for publication. If you opted to change the Name, you will need to update the the file -paths before kniting.

    +paths before knitting.

  • diff --git a/docs/articles/Using-the-DRR-Template.html b/docs/articles/Using-the-DRR-Template.html index c605d0f..451e9c7 100644 --- a/docs/articles/Using-the-DRR-Template.html +++ b/docs/articles/Using-the-DRR-Template.html @@ -158,24 +158,27 @@

    Code ChunksORCID for more information about ORCID +to the order of authors in the authorNames list. If an +author was listed more than once in the authorNames list, +the corresponding ORCID (or NA) should also be listed more than once. +Future iterations of the DRR Template will pull ORCID iDs from metadata +and eventually from Active Directory. See ORCID for more information about ORCID iDs or to register an ORCID iD.
  • DRRabstract. The abstract for the DRR (which may be @@ -209,7 +212,9 @@

    Code ChunksCode ChunksCode ChunksCode Chunks