Skip to content

Commit

Permalink
doc: license year and R-Universe link (ideas-lab-nus#84)
Browse files Browse the repository at this point in the history
* doc: fix link errors

* doc: add `CITATION` file

* doc: fix test coverage workflow file

* doc: update license year

* doc: update doc about install dev version

* doc: fix EC-Earth link

* doc: remove EsgfQuery link
  • Loading branch information
hongyuanjia authored Mar 10, 2024
1 parent 6763e75 commit 401b432
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 12 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
YEAR: 2019-2021
YEAR: 2019-2024
COPYRIGHT HOLDER: Hongyuan Jia and Adrian Chong
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MIT License

Copyright (c) 2019-2021 Hongyuan Jia and Adrian Chong
Copyright (c) 2019-2024 Hongyuan Jia and Adrian Chong

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
13 changes: 9 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ file.copy(file.path("/mnt/d/ScenarioMIP", f), tempdir())

> Create future EnergyPlus Weather files using CMIP6 data
# How to cite
## How to cite

To cite epwshiftr in publications use:

Expand Down Expand Up @@ -97,7 +97,12 @@ install.packages("epwshiftr")
Alternatively, you can install the development version from GitHub.

```{r gh-install, eval = FALSE}
install.packages("epwshiftr", repos = "https://hongyuanjia.r-universe.dev")
install.packages("epwshiftr",
repos = c(
ideaslab = "https://ideas-lab-nus.r-universe.dev",
cran = "https://cran.r-project.org"
)
)
```

## Get started
Expand Down Expand Up @@ -245,7 +250,7 @@ Hongyuan Jia and Adrian Chong

epwshiftr is released under the terms of MIT License.

Copyright © 2019-2021 Hongyuan Jia and Adrian Chong
Copyright © 2019-2024 Hongyuan Jia and Adrian Chong

* **CMIP6 data**

Expand All @@ -265,7 +270,7 @@ Consult [Terms of Use](https://pcmdi.llnl.gov/CMIP6/TermsOfUse/) for terms of us
governing CMIP6 output, including citation requirements and proper
acknowledgment. Further information about each GCM output data, including some
limitations, can be found via the `further_info_url` (recorded as a **global
attribute** in the NetCDF file) and at [EC-Earth](https://www.ec-earth.org). The
attribute** in the NetCDF file) and at [EC-Earth](https://www.ec-earth.org/). The
data producers and data providers make no warranty, either express or implied,
including, but not limited to, warranties of merchantability and fitness for a
particular purpose. All liabilities arising from the supply of the information
Expand Down
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ coverage](https://codecov.io/gh/ideas-lab-nus/epwshiftr/branch/master/graph/badg

> Create future EnergyPlus Weather files using CMIP6 data
# How to cite
## How to cite

To cite epwshiftr in publications use:

Expand Down Expand Up @@ -71,7 +71,12 @@ install.packages("epwshiftr")
Alternatively, you can install the development version from GitHub.

``` r
install.packages("epwshiftr", repos = "https://hongyuanjia.r-universe.dev")
install.packages("epwshiftr",
repos = c(
ideaslab = "https://ideas-lab-nus.r-universe.dev",
cran = "https://cran.r-project.org"
)
)
```

## Get started
Expand Down Expand Up @@ -488,7 +493,7 @@ Hongyuan Jia and Adrian Chong

epwshiftr is released under the terms of MIT License.

Copyright © 2019-2021 Hongyuan Jia and Adrian Chong
Copyright © 2019-2024 Hongyuan Jia and Adrian Chong

- **CMIP6 data**

Expand All @@ -509,7 +514,7 @@ Consult [Terms of Use](https://pcmdi.llnl.gov/CMIP6/TermsOfUse/) for terms of us
governing CMIP6 output, including citation requirements and proper
acknowledgment. Further information about each GCM output data, including some
limitations, can be found via the `further_info_url` (recorded as a **global
attribute** in the NetCDF file) and at [EC-Earth](https://www.ec-earth.org). The
attribute** in the NetCDF file) and at [EC-Earth](https://www.ec-earth.org/). The
data producers and data providers make no warranty, either express or implied,
including, but not limited to, warranties of merchantability and fitness for a
particular purpose. All liabilities arising from the supply of the information
Expand Down
2 changes: 0 additions & 2 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ navbar:
menu:
- text: "Manage CMIP6 CVs and Data Request"
href: articles/cmip6_dict.html
- text: "Work with ESGF search RESTful API"
href: reference/EsgfQuery.html
reference:
text: Manual
href: reference/index.html
Expand Down

0 comments on commit 401b432

Please sign in to comment.