Skip to content

Commit be4c64f

Browse files
committed
Update package readme
1 parent cdbfebe commit be4c64f

2 files changed

Lines changed: 23 additions & 40 deletions

File tree

README.Rmd

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -88,20 +88,23 @@ remotes::install_github('ASRCsoft/atmoschem.process', dependencies = TRUE)
8888

8989
- R and R package dependencies
9090
- GNU Make
91-
- 15GB of disk space
91+
- 15GB of disk space and 8GB of RAM
92+
- An Air Quality System API key (get one
93+
[here](https://aqs.epa.gov/aqsweb/documents/data_api.html))
94+
- A user/password for the ASRC's atmoschem server (sign up
95+
[here](http://atmoschem.asrc.cestm.albany.edu/))
9296

9397
### Creating the dataset
9498

9599
Download or clone the repository. The dataset package can be generated by
96-
running (from a terminal)
100+
running, from a terminal,
97101

98102
```sh
99-
cd path/to/atmoschem.process
100-
make routine
103+
cd /path/to/atmoschem.process
104+
make routine asrc_user=youruser asrc_pass=yourpassword aqs_email=youremail aqs_key=yourkey
101105
```
102106

103-
You will be asked for the atmoschem server's data password (twice), which can be
104-
obtained from [the atmoschem website](http://atmoschem.asrc.cestm.albany.edu/).
107+
(replacing the values with your information).
105108

106109
### Viewing the data
107110

@@ -114,11 +117,8 @@ make view
114117

115118
## Citation
116119

117-
The package citation can be obtained by running `citation('atmoschem.process')`:
118-
119-
```{r citation, echo = FALSE, comment=""}
120-
citation('atmoschem.process')
121-
```
120+
Please cite this package using the citation available from Zenodo:
121+
[![DOI](https://zenodo.org/badge/157783204.svg)](https://zenodo.org/badge/latestdoi/157783204)
122122

123123
## License
124124

README.md

Lines changed: 12 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -82,21 +82,23 @@ remotes::install_github('ASRCsoft/atmoschem.process', dependencies = TRUE)
8282

8383
- R and R package dependencies
8484
- GNU Make
85-
- 15GB of disk space
85+
- 15GB of disk space and 8GB of RAM
86+
- An Air Quality System API key (get one
87+
[here](https://aqs.epa.gov/aqsweb/documents/data_api.html))
88+
- A user/password for the ASRC’s atmoschem server (sign up
89+
[here](http://atmoschem.asrc.cestm.albany.edu/))
8690

8791
### Creating the dataset
8892

8993
Download or clone the repository. The dataset package can be generated
90-
by running (from a terminal)
94+
by running, from a terminal,
9195

9296
``` sh
93-
cd path/to/atmoschem.process
94-
make routine
97+
cd /path/to/atmoschem.process
98+
make routine asrc_user=youruser asrc_pass=yourpassword aqs_email=youremail aqs_key=yourkey
9599
```
96100

97-
You will be asked for the atmoschem server’s data password (twice),
98-
which can be obtained from [the atmoschem
99-
website](http://atmoschem.asrc.cestm.albany.edu/).
101+
(replacing the values with your information).
100102

101103
### Viewing the data
102104

@@ -109,35 +111,16 @@ make view
109111

110112
## Citation
111113

112-
The package citation can be obtained by running
113-
`citation('atmoschem.process')`:
114-
115-
```
116-
117-
To cite package 'atmoschem.process' in publications use:
118-
119-
William May (2020). atmoschem.process: ASRC Atmospheric Chemistry
120-
Data Processing. R package version 0.5.0.
121-
https://github.com/ASRCsoft/atmoschem.process
122-
123-
A BibTeX entry for LaTeX users is
124-
125-
@Manual{,
126-
title = {atmoschem.process: ASRC Atmospheric Chemistry Data Processing},
127-
author = {William May},
128-
year = {2020},
129-
note = {R package version 0.5.0},
130-
url = {https://github.com/ASRCsoft/atmoschem.process},
131-
}
132-
```
114+
Please cite this package using the citation available from Zenodo:
115+
[![DOI](https://zenodo.org/badge/157783204.svg)](https://zenodo.org/badge/latestdoi/157783204)
133116

134117
## License
135118

136119
`atmoschem.process` is released under the open source MIT license.
137120

138121
## References
139122

140-
<div id="refs" class="references hanging-indent">
123+
<div id="refs" class="references">
141124

142125
<div id="ref-brandt_atmospheric_2016">
143126

0 commit comments

Comments
 (0)