Skip to content

Commit

Permalink
clean up readme and rbuildignore
Browse files Browse the repository at this point in the history
  • Loading branch information
eeholmes committed Jul 7, 2021
1 parent 1bb93ee commit 48f5b58
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 12 deletions.
3 changes: 2 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
^.*\.Rproj$
^\.Rproj\.user$
^\.github$
data-raw
^_pkgdown\.yml$
^docs$
^pkgdown$
^inst\extdata$
^Readme.md$
2 changes: 1 addition & 1 deletion R/process_data_raw.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#'
#' Process's the Roxygen header on the csv files in data-raw into R files for each data set into
#' data folder and R folder
#'
#' @keywords internal
#' @export
process_data_raw <- function() {

Expand Down
18 changes: 15 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,26 @@
# README

This has a function called `process_data_raw()`. When you type
**See the [WEBSITE](https://nwfsc-math-bio.github.io/SRData/) for the data information. This Readme is for the package and data maintainers.**

## New data

* Add new csv files to the `data-raw` folder with the Roxygen2 headers.
* Push to GitHub and the data will the automaticall processed for the website.

## Changing the man files and vignettes

The man files appear under the Reference tab and the vignettes appear under the Articles tab. The R and Rmd files for these are created by the function
`process_data_raw()`. When you type
```
process_data_raw()
```
It processes the csv file in `data-raw` folder into a `.rda` object in `data`, a `.R` file, and a `.Rmd` vignette usingthe Roxygen header on the csv file.
It processes the csv file in `data-raw` folder into a `.rda` object in `data`, a `.R` file, and a `.Rmd` vignette usingthe Roxygen header on the csv file. Change this file to change the look of the man or article files.

When the package is built, you can do ?<data-name> to get the meta information.

Note, you can run `process_data_raw()` locally, but the GitHub repo is set up with a GitHub Action to automatically run `process_data_raw()` whenever a push to the `data-raw` folder happens. I probably ought to set it up to do a pull-request instead of pushing right to master branch, but I am not sure how to do that. So that's on the To-Do list.
## Updating the webpage locally

Note, you can run `process_data_raw()` locally, but the GitHub repo is set up with a GitHub Action to automatically run `process_data_raw()` whenever a push to the `data-raw` folder happens.

## Workflow

Expand Down
2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ articles:
Upper-Columbia-River-Steelhead-DPS: Upper-Columbia-River-Steelhead-DPS.html
Upper-Willamette-River-Chinook-Salmon-ESU: Upper-Willamette-River-Chinook-Salmon-ESU.html
Upper-Willamette-River-Steelhead-DPS: Upper-Willamette-River-Steelhead-DPS.html
last_built: 2021-07-07T17:33Z
last_built: 2021-07-07T17:58Z

6 changes: 0 additions & 6 deletions docs/reference/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/process_data_raw.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 48f5b58

Please sign in to comment.