Suggested edits to vignettes about drr_template HOT 5 CLOSED

DRR Outline and Content Guide:

• Section 4: DQE Fix misspelling of 'intendend'
• Section 4: Regarding 'patterns in data that do not meet established standards or data quality objectives', does this imply an EDA level 0 summary of the dataset structure?
• Section 8: Change section title to 'Code Listing' since we use non-R languages in the Program
• Ditto for Section 9

Question re: section 8 - Add a statement to specify the intent that this section includes both the report formatting and the data processing content (i.e. the RMD or IPYNB contains all processing code)?

from drr_template.

How to Use the DRR Template:

• Do DRRs include the code for redacting/fuzzing (etc.) of protected data? Hmm... Perhaps a section on DRRs for protected vs. not protected data is needed.
• Until we have a robust GitHub Enterprise option and have set up our desired Science Branch publication structure, I would not recommend the first approach under section 2 Project Setup.
• Ditto for the Getting Started section of the intro readme.md
  
  Expect further comments since I've not tried using the workflow suggested in this vignette...

from drr_template.

Creating Data Packages:

• Step 3: Change 'Create the CSV' file to 'Create the Delimited File'. As we proceed with dataset production, most of our tabular outputs will be tab-delimited, not comma-delimited since the latter is challenging to produce and use.
  -Step 5: Create the Attributes Table section - suggest including a recommendation of using GMT if datetime content is used
  -Step 6: Create Category Variables Table - add a tab-delimited file containing the values in Table 4 to the data_objects folder.
• Step 7: Correct title to Set Geographic Coverage
• Step 7: EML has a robust structure for documenting spatial data. Two things:
  -- 'Coverage' implies bounding extent, not actual geography elements, so I don't agree with replication of coordinate values for point data within this section - those should be reflected in geometry objects in eml-spatialVector section of the eml file assuming we intend to include them.
  -- Spatial reference must be included i.e. NAD2011 Geographic, UTM Zone 12N NAD83, etc.) and the eml-spatialVector section includes elements for this.

from drr_template.

made several changes based on comments. we can talk about the ones I did not change.
In general I'm staying away from providing any guidance on data standards or related to other policies with this guidance b/c it may be used by others outside IMD (like other series) and may change.

from drr_template.

One point on defining QA and QC - it seems the How to Use vignette is the appropriate place for those definitions. I concur with the approach to emphasize comparison to quality standards and think clear definitions of QA and QC in this vignette help emphasize both the distinction between quality standard checks and QA QC operations which are implied and sometimes documented by other DRR components.

from drr_template.