From a4ae531a7c0ac89c3ae87249b11608e5202b7954 Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Mon, 12 Feb 2024 14:23:15 -0700 Subject: [PATCH] update documentation --- vignettes/articles/Starting-a-DRR.Rmd | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/vignettes/articles/Starting-a-DRR.Rmd b/vignettes/articles/Starting-a-DRR.Rmd index ff3dd09..fc1f056 100644 --- a/vignettes/articles/Starting-a-DRR.Rmd +++ b/vignettes/articles/Starting-a-DRR.Rmd @@ -20,15 +20,17 @@ knitr::opts_chunk$set(echo = FALSE) [Purpose and Scope of Data Release Reports](DRR_Purpose_and_Scope.html) -This is a template is for use when drafting Data Release Reports. 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 rather than presenting results, testing hypotheses, or presenting new interpretations and in-depth analyses. +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 rather than presenting results, testing hypotheses, or presenting new interpretations and in-depth analyses. -# 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 -1. **To start your DRR you will need all of your data in flat .csv files**. All quality assurance, quality control, and quality flagging should be completed. Ideally you have already created or are in the process of creating a data package. 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. +1. **To start your DRR you will need all of your data in flat .csv files**. All quality assurance, quality control, and quality flagging should be completed. Ideally you have already created or are in the process of creating a data package (see the [documentation](https://nationalparkservice.github.io/EMLeditor/articles/a02_EML_creation_script.html) associated with the R package [EMLeditor](https://nationalparkservice.github.io/EMLeditor/index.html) 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. 2. **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 can use that same R project. @@ -51,7 +53,7 @@ devtools::install_github("nationalparkservice/QCkit") library(QCkit) ``` -4. **Open a new DRR Template**. From within Rstudio, 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 other than "Untitled", but if you do so the example DRR will not render properly. Click OK. A new folder will be generated in your current working directory titled, "Untitled" (or whatever name you have opted to call it). +4. **Open a new DRR Template**. From within Rstudio, 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 other than "Untitled", but if you do so the example DRR will not render properly. Click OK. A new folder will be generated in your current working directory titled, "Untitled" (or whatever name you have opted to call it). ```{r echo = FALSE, out.width = "40%", out.height = "20%", fig.caption = "Opening a new DRR Template"} knitr::include_graphics(c("new_rmd.png", "new_rmd_template.png")) @@ -59,11 +61,11 @@ knitr::include_graphics(c("new_rmd.png", "new_rmd_template.png")) 5. After selecting "OK" two things will happen: First, you the DRR Template file will open up. It is called "Untitled.Rmd" by default. Second, a new folder will be created called "Untitled" (Unless you opted to change the default "Name:" in the "New R Markdown" pop up, then these will have whatever name you gave them). -6. **Edit the DRR Template** according to your specifications and the instructions in the ["Using the DRR Template"](Using-the-DRR-Template.html) guide. +6. **Edit the DRR Template** to reflect the data you would like to descibe and according to the instructions in the ["Using the DRR Template"](Using-the-DRR-Template.html) guide. 7. **"knit" the .rmd file to Word** when you are done editing it. Submit the resulting .docx file for publication (via a yet-to-be-determined process). # Examples -**Knit your own example DRR:** Assuming you left the "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. +**Knit your own example DRR:** Assuming you left the "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 knitting.