forked from NOAA-EDAB/tech-doc
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathskeleton.rmd
More file actions
107 lines (59 loc) · 2.7 KB
/
Copy pathskeleton.rmd
File metadata and controls
107 lines (59 loc) · 2.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
---
title: "Tech Memo Methods Template"
output:
word_document: default
html_document: default
bibliography: XYZ.bib
---
<!-- STOP!!!!! INSERT THE FILE NAME OF YOUR .bib BIBLIOGRAPHY ABOVE.-->
```{r setup, echo = F, message=F}
#Load packages
library(knitr)
library(rmarkdown)
```
The purpose of this form is to provide the methods used to collect, process, and analyze derived data prior to data submission for all EDAB reports. This information will be compiled into the State of the Ecosystem Tech Memo, AND be used to meet metadata requirements put forth by the Public Access to Research Results (PARR) directive.
For the tech memo, we will be documenting the methods behind each indicator to the level of a peer-reviewed document.
## Contributor name(s)
## Data name
### Indicator category
Indicate from the list below which category the contributed data fall under by deleting other entries.
1. Database pull
2. Database pull with analysis
3. Synthesis of published information
4. Extensive analysis; not yet published
5. Published methods
## Methods
### Data source(s) (All types)
Please provide a text description of data sources.
### Data extraction
Text overview description of extraction methods. What information was extracted and how was it aggregated? Can point to other indicator extraction methods if the same.
Write SQL query here
```{sql, eval = F, echo = T}
SELECT * FROM...
```
R code used in extraction process.
```{r r_extract, echo = T, eval = F}
# Insert R code used for extraction here
```
### Data analysis
Text description of analysis methods, similar in structure and detail to a peer-reviewed paper methods section.
What packages or libraries did you use in your work flow?
```{r packages, echo = T}
sessionInfo(package = NULL)
#Insert packages used here
#Use this to output a detailed list of the package information
#current.session <- sessionInfo(package = NULL)
#current.session$otherPkgs
```
Include accompanying R code, pseudocode, flow of scripts, and/or link to location of code used in analyses.
```{r analysis, echo = T, eval = F}
# Insert analysis code here
```
### Further metadata
Fill out the following metadata required by PARR under each subheader.
#### Public availability statement
Will source data be available to the public? If not, is a Data Access Waiver necessary?
#### Point of contact - Whom should be contacted?
#### Data steward (can be POC; in charge of keeping data updated)
References
<!-- References must be submitted in BibTeX format. When compiling this document, they will appear in this section. There is no need to write them out here. Don't forget to include the name of your .bib file in the YAML header (fill in XYZ.bib in YAML header)!!!!!-->