Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Limit github API hits during install #34

Merged
merged 7 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@
^\.Rproj\.user$
^LICENSE\.md$
^README\.Rmd$
^_pkgdown\.yml$
^docs$
^pkgdown$
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
.RData
.Ruserdata
inst/doc
docs
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: NPSdataverse
Title: Tools and Packages for Data and Metadata Manipulation
Version: 0.0.2
Version: 0.1.0
Authors@R: c(
person(given="Robert", family="Baker", email="[email protected]",
role = c("aut", "cre"),
Expand Down
7 changes: 6 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# NPSdataverse 0.0.2
# NPSdataverse 0.1.0

2024-08-19
* Reduce github.com API rate limits by only hitting API in interactive session.

2024-07-26
* Updated license from MIT to CC0.
* Start paper.md for JOSS
* Add paper.bib for JOSS

# NPSdataverse 0.0.2

2024-01-02

* Added function ability to load NPSdataverse (using library()) when offline
Expand Down
6 changes: 4 additions & 2 deletions R/zzz.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
#if internet access is available, check for updated packages:
#check for github packages that need updating

if(is_online()){
.update_git_repos()
if(is_online()) {
if (interactive()) {
.update_git_repos()
}
} else {
packageStartupMessage("Warning: You are offline. Cannot check for package updates.\n")
}
Expand Down
14 changes: 14 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,16 @@ knitr::opts_chunk$set(
```

# NPSdataverse

```{r echo=FALSE, fig.align="center"}
#| fig.alt: >
#| Image diagraming NPSdataverse and its consituent packages using hexicons
#| A hexicon of NPSdataverse points to the hexicons for the 4 NPS-maintained
#| packages that load with the NPSdataverse: QCkit, EMLeditor, DPchecker, and
#| NPSutils. The key external packages EML and EMLassemblyline that also load
#| are included in a text box.
knitr::include_graphics("man/figures/NPSdataverse_overview.jpg")
#![alt text]("man/figures/NPSdataverse_overview.jpg")
```
NPSdataverse loads a suite of R packages for creating, manipulating, and accessing data packages including interacting with DataStore. This is an early version of the NPSdataverse. Please request enhancements and bug fixes through [Issues](https://github.com/nationalparkservice/NPSdataverse/issues).

Expand Down Expand Up @@ -77,12 +85,18 @@ If you are you are creating a data package and need to generate EML metadata mak
After loading NPSdataverse, from within Rstudio select the "File" menu. Select "New File" from the drop down menu and choose "R Markdown". In the dialog box that pops up, select "From Template" and then click on the template labelled "Editable_EML_Creation_Workflow" and click "OK".

```{r echo=FALSE, out.width='45%', fig.align="center"}
#| fig.alt: >
#| A screenshot with highlights indicating how to access the EML script
#| This figure shows step 1.
knitr::include_graphics("man/figures/open_rmd.png")

```


```{r echo=FALSE, out.width='45%', fig.show='hold', fig.align='center'}
#| fig.alt: >
#| A screenshot with highlights indicating how to access the EML script
#| This figure shows step 2.
knitr::include_graphics("man/figures/EMLtemplate.png")
```

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# NPSdataverse

<img src="man/figures/NPSdataverse_overview.jpg" width="100%" style="display: block; margin: auto;" />
<img src="man/figures/NPSdataverse_overview.jpg" alt="Image diagraming NPSdataverse and its consituent packages using hexicons A hexicon of NPSdataverse points to the hexicons for the 4 NPS-maintained packages that load with the NPSdataverse: QCkit, EMLeditor, DPchecker, and NPSutils. The key external packages EML and EMLassemblyline that also load are included in a text box." width="100%" style="display: block; margin: auto;" />
NPSdataverse loads a suite of R packages for creating, manipulating, and
accessing data packages including interacting with DataStore. This is an
early version of the NPSdataverse. Please request enhancements and bug
Expand Down Expand Up @@ -76,9 +76,9 @@ Select “New File” from the drop down menu and choose “R Markdown”. In
the dialog box that pops up, select “From Template” and then click on
the template labelled “Editable_EML_Creation_Workflow” and click “OK”.

<img src="man/figures/open_rmd.png" width="45%" style="display: block; margin: auto;" />
<img src="man/figures/open_rmd.png" alt="A screenshot with highlights indicating how to access the EML script This figure shows step 1." width="45%" style="display: block; margin: auto;" />

<img src="man/figures/EMLtemplate.png" width="45%" style="display: block; margin: auto;" />
<img src="man/figures/EMLtemplate.png" alt="A screenshot with highlights indicating how to access the EML script This figure shows step 2." width="45%" style="display: block; margin: auto;" />

This will open a new file on that you can edit to generate EML metadata
for your data package. See the [web pages associated with
Expand Down
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: https://github.com/nationalparkservice/NPSdataverse
template:
bootstrap: 5

116 changes: 43 additions & 73 deletions docs/404.html

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

Loading