diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index dbf00b85..00000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,129 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, religion, or sexual identity and -orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behaviour that contributes to a positive environment for our -community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, -and learning from the experience -* Focusing on what is best not just for us as individuals, but for the overall -community - -Examples of unacceptable behaviour include: - -* The use of sexualised language or imagery, and sexual attention or -advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email -address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a -professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards -of acceptable behaviour and will take appropriate and fair corrective action in -response to any behaviour that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies -when an individual is officially representing the community in public spaces. -Examples of representing our community include using an official e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behaviour may be -reported to the community leaders responsible for enforcement at -adamhsparks@gmail.com. All complaints will be reviewed and investigated promptly -and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behaviour deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behaviour was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series of -actions. - -**Consequence**: A warning with consequences for continued behaviour. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or permanent -ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behaviour. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behaviour, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within the -community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, -available at https://www.contributor-covenant.org/version/2/0/ -code_of_conduct.html. - -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at https:// -www.contributor-covenant.org/translations. diff --git a/README.Rmd b/README.Rmd index b3b41feb..dea114ac 100644 --- a/README.Rmd +++ b/README.Rmd @@ -77,11 +77,12 @@ More documentation is available in the vignette in your R session, `vignette("na ## Meta -- Please [report any issues or bugs](https://github.com/ropensci/nasapower/issues). -Please note that the {nasapower} project is released with a [Contributor Code of Conduct](https://github.com/ropensci/nasapower/blob/main/CODE_OF_CONDUCT.md). -By participating in the {nasapower} project you agree to abide by its terms. +- Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). +By contributing to this project, you agree to abide by its terms. -- License: MIT +- Please [report any issues or bugs](https://github.com/ropensci/nasapower/issues). + +- License: MIT ## References diff --git a/README.md b/README.md index 7e640fff..0e00b823 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,40 @@ +--- +output: github_document +--- # {nasapower}: NASA POWER API Client logo -[![tic](https://github.com/ropensci/nasapower/workflows/tic/badge.svg?branch=main)](https://github.com/ropensci/nasapower/actions) -[![codecov](https://codecov.io/gh/ropensci/nasapower/branch/main/graph/badge.svg?token=Kq9aea0TQN)](https://app.codecov.io/gh/ropensci/nasapower) -[![DOI](https://zenodo.org/badge/109224461.svg)](https://zenodo.org/badge/latestdoi/109224461) -[![Project Status: Active – The project has reached a stable, usable -state and is being actively -developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) -[![peer-review](https://badges.ropensci.org/155_status.svg)](https://github.com/ropensci/software-review/issues/155) +[![tic](https://github.com/ropensci/nasapower/workflows/tic/badge.svg?branch=main)](https://github.com/ropensci/nasapower/actions) +[![codecov](https://codecov.io/gh/ropensci/nasapower/branch/main/graph/badge.svg?token=Kq9aea0TQN)](https://app.codecov.io/gh/ropensci/nasapower) +[![DOI](https://zenodo.org/badge/109224461.svg)](https://zenodo.org/badge/latestdoi/109224461) +[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) +[![peer-review](https://badges.ropensci.org/155_status.svg)](https://github.com/ropensci/software-review/issues/155) [![DOI](http://joss.theoj.org/papers/10.21105/joss.01035/status.svg)](https://doi.org/10.21105/joss.01035) -[![CRAN -status](https://www.r-pkg.org/badges/version/nasapower)](https://CRAN.R-project.org/package=nasapower) +[![CRAN status](https://www.r-pkg.org/badges/version/nasapower)](https://CRAN.R-project.org/package=nasapower) ## POWER data vs {nasapower} Please note that {nasapower} is **NOT** the source of NASA POWER data. It is only an API client that allows easy access to the data. -{nasapower} does not redistribute the data or provide it in any way, *we -encourage users to follow the requests of the POWER Project Team and -properly acknowledge them for the data rather than citing this package* -(unless you have actually used it in your work). - -> *When POWER data products are used in a publication, we request the -> following acknowledgement be included: “These data were obtained from -> the NASA Langley Research Center POWER Project funded through the NASA -> Earth Science Directorate Applied Science Program.”* - -The previous statement that properly cites the POWER data is different -than the citation for {nasapower}. To cite this R package, {nasapower}, -please use the output from `citation(package = "nasapower")` and cite -both the package manual, which includes the version you used and the -paper which refers to the peer-review of the software package as the -functionality of the package has changed and will likely change to match -the API in the future as necessary. +{nasapower} does not redistribute the data or provide it in any way, *we encourage users to follow the requests of the POWER Project Team and properly acknowledge them for the data rather than citing this package* (unless you have actually used it in your work). + + >*When POWER data products are used in a publication, we request the following acknowledgement be included: + "These data were obtained from the NASA Langley Research Center POWER Project funded through the NASA Earth + Science Directorate Applied Science Program."* + +The previous statement that properly cites the POWER data is different than the citation for {nasapower}. +To cite this R package, {nasapower}, please use the output from `citation(package = "nasapower")` and cite both the package manual, which includes the version you used and the paper which refers to the peer-review of the software package as the functionality of the package has changed and will likely change to match the API in the future as necessary. ## About {nasapower} -{nasapower} aims to make it quick and easy to automate *downloading* of -the [NASA-POWER](https://power.larc.nasa.gov) global meteorology, -surface solar energy and climatology data in your R session as a tidy -data frame `tibble` object for analysis and use in modelling or other -purposes. POWER (Prediction Of Worldwide Energy Resource) data are -freely available for download with varying spatial resolutions dependent -on the original data and with several temporal resolutions depending on -the POWER parameter and community. +{nasapower} aims to make it quick and easy to automate *downloading* of the [NASA-POWER](https://power.larc.nasa.gov) global meteorology, surface solar energy and climatology data in your R session as a tidy data frame `tibble` object for analysis and use in modelling or other purposes. +POWER (Prediction Of Worldwide Energy Resource) data are freely available for download with varying spatial resolutions dependent on the original data and with several temporal resolutions depending on the POWER parameter and community. -**Note that the data are not static and may be replaced with improved -data.** Please see for -detailed information in this regard. +**Note that the data are not static and may be replaced with improved data.** +Please see for detailed information in this regard. ### Quick start @@ -60,7 +44,8 @@ detailed information in this regard. The stable version is available through CRAN. -``` r + +```r install.packages("nasapower") ``` @@ -68,17 +53,17 @@ install.packages("nasapower") A development version is available through GitHub. -``` r + +```r install.packages("nasapower", repos = "https://ropensci.r-universe.dev") ``` ### Example -Fetch daily “ag” community temperature, relative humidity and -precipitation for January 1, 1985 for Kingsthorpe, Queensland, -Australia. +Fetch daily “ag” community temperature, relative humidity and precipitation for January 1, 1985 for Kingsthorpe, Queensland, Australia. -``` r + +```r library("nasapower") daily_ag <- get_power(community = "ag", lonlat = c(151.81, -27.48), @@ -89,37 +74,35 @@ daily_ag <- get_power(community = "ag", daily_ag ``` - ## NASA/POWER CERES/MERRA2 Native Resolution Daily Data - ## Dates (month/day/year): 01/01/1985 through 01/01/1985 - ## Location: Latitude -27.48 Longitude 151.81 - ## Elevation from MERRA-2: Average for 0.5 x 0.625 degree lat/lon region = 442.77 meters - ## The value for missing source data that cannot be computed or is outside of the sources availability range: NA - ## Parameter(s): - ## - ## Parameters: - ## RH2M MERRA-2 Relative Humidity at 2 Meters (%) ; - ## T2M MERRA-2 Temperature at 2 Meters (C) ; - ## PRECTOTCORR MERRA-2 Precipitation Corrected (mm/day) - ## - ## # A tibble: 1 × 10 - ## LON LAT YEAR MM DD DOY YYYYMMDD RH2M T2M PRECTOTCORR - ## - ## 1 152. -27.5 1985 1 1 1 1985-01-01 54.7 24.9 0.9 +``` +## NASA/POWER CERES/MERRA2 Native Resolution Daily Data +## Dates (month/day/year): 01/01/1985 through 01/01/1985 +## Location: Latitude -27.48 Longitude 151.81 +## Elevation from MERRA-2: Average for 0.5 x 0.625 degree lat/lon region = 442.77 meters +## The value for missing source data that cannot be computed or is outside of the sources availability range: NA +## Parameter(s): +## +## Parameters: +## RH2M MERRA-2 Relative Humidity at 2 Meters (%) ; +## T2M MERRA-2 Temperature at 2 Meters (C) ; +## PRECTOTCORR MERRA-2 Precipitation Corrected (mm/day) +## +## # A tibble: 1 × 10 +## LON LAT YEAR MM DD DOY YYYYMMDD RH2M T2M PRECTOTCORR +## +## 1 152. -27.5 1985 1 1 1 1985-01-01 54.7 24.9 0.9 +``` ## Documentation -More documentation is available in the vignette in your R session, -`vignette("nasapower")` or available online, -. +More documentation is available in the vignette in your R session, `vignette("nasapower")` or available online, . ## Meta -- Please [report any issues or - bugs](https://github.com/ropensci/nasapower/issues). Please note that - the {nasapower} project is released with a [Contributor Code of - Conduct](https://github.com/ropensci/nasapower/blob/main/CODE_OF_CONDUCT.md). - By participating in the {nasapower} project you agree to abide by its - terms. +- Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). +By contributing to this project, you agree to abide by its terms. + +- Please [report any issues or bugs](https://github.com/ropensci/nasapower/issues). - License: MIT