data-raw/README.md

In adamhsparks/nasapower: NASA POWER API Client

Fetch NASA-POWER Parameters and Include Them as an Internal List

Adam H. Sparks 2024-01-31

Create parameters nested list for internal checks before sending queries to POWER server

These data are used for internal checks to be sure that data requested from the POWER dataset are valid. The POWER list of parameters that can be queried is available as an API query from the POWER server.

The list structure will be

• parameters
• HOURLY_AG
  • parameter_1 …
  • parameter_n
• DAILY_AG
  • parameter_1 …
  • parameter_n
• MONTHLY_AG
  • parameter_1 …
  • parameter_n
• CLIMATOLOGY_AG
  • parameter_1 …
  • parameter_n
• HOURLY_RE
  • parameter_1 …
  • parameter_n
• DAILY_RE
  • parameter_1 …
  • parameter_n
• MONTHLY_RE
  • parameter_1 …
  • parameter_n
• CLIMATOLOGY_RE
  • parameter_1 …
  • parameter_n
• HOURLY_SB
  • parameter_1 …
  • parameter_n
• DAILY_SB
  • parameter_1 …
  • parameter_n
• MONTHLY_SB
  • parameter_1 …
  • parameter_n
• CLIMATOLOGY_SB
  • parameter_1 …
  • parameter_n

POWER JSON file

Using purrr::map2 and jsonlite::fromJSON() read the JSON file into R creating a single, nested list and reorder it alphabetically by parameter name.

library(purrr)
library(jsonlite)

## 
## Attaching package: 'jsonlite'

## The following object is masked from 'package:purrr':
## 
##     flatten

temporal_api <- c("HOURLY", "DAILY", "MONTHLY", "CLIMATOLOGY")
community <- c("AG", "RE", "SB")

# create all combinations
vals <- expand.grid(temporal_api, community, stringsAsFactors = FALSE)

# create equal length vectors for purrr::map2
temporal_api <- vals[, 1]
community <- vals[, 2]

base_url <- "https://power.larc.nasa.gov/api/system/manager/parameters?"

power_pars <- map2(.x = temporal_api,
                    .y = community,
                    .f = ~ fromJSON(sprintf(
                    "%stemporal=%s&community=%s", base_url, .x, .y)
                    ))

names(power_pars) <- paste(temporal_api, community, sep = "_")

# create a list of vectors for each temporal API/par combination for easier
# checking and validation
parameters <- vector(mode = "list", length = length(power_pars))
names(parameters) <- names(power_pars)
for (i in names(power_pars)) {
    parameters[[i]] <- names(power_pars[[i]])
}

parameters <- map(.x = parameters, .f = sort)

Save list for use in nasapower package

Using usethis::use_data() save the list as an R data object for use in the nasapower package. These values will not be exposed to the user and so will not be documented as previously. Users will be be pointed to functions to interact directly with the POWER APIs to query information for the temporal API/community combinations or for the parameters themselves.

usethis::use_data(parameters, overwrite = TRUE, internal = TRUE)

Session Info

sessioninfo::session_info()

## ─ Session info ───────────────────────────────────────────────────────────────
##  setting  value
##  version  R version 4.3.2 (2023-10-31)
##  os       macOS Sonoma 14.3
##  system   aarch64, darwin20
##  ui       X11
##  language (EN)
##  collate  en_US.UTF-8
##  ctype    en_US.UTF-8
##  tz       Australia/Perth
##  date     2024-01-31
##  pandoc   3.1.11.1 @ /opt/homebrew/bin/ (via rmarkdown)
## 
## ─ Packages ───────────────────────────────────────────────────────────────────
##  package     * version date (UTC) lib source
##  askpass       1.2.0   2023-09-03 [1] CRAN (R 4.3.0)
##  cli           3.6.2   2023-12-11 [1] CRAN (R 4.3.1)
##  colorout      1.3-0.1 2024-01-30 [1] local
##  crayon        1.5.2   2022-09-29 [1] CRAN (R 4.3.0)
##  credentials   2.0.1   2023-09-06 [1] CRAN (R 4.3.0)
##  desc          1.4.3   2023-12-10 [1] CRAN (R 4.3.1)
##  digest        0.6.34  2024-01-11 [1] CRAN (R 4.3.1)
##  evaluate      0.23    2023-11-01 [1] CRAN (R 4.3.1)
##  fansi         1.0.6   2023-12-08 [1] CRAN (R 4.3.1)
##  fastmap       1.1.1   2023-02-24 [1] CRAN (R 4.3.0)
##  fs            1.6.3   2023-07-20 [1] CRAN (R 4.3.0)
##  glue          1.7.0   2024-01-09 [1] CRAN (R 4.3.1)
##  htmltools     0.5.7   2023-11-03 [1] CRAN (R 4.3.1)
##  jsonlite    * 1.8.8   2023-12-04 [1] CRAN (R 4.3.1)
##  knitr         1.45    2023-10-30 [1] CRAN (R 4.3.1)
##  lifecycle     1.0.4   2023-11-07 [1] CRAN (R 4.3.1)
##  magrittr      2.0.3   2022-03-30 [1] CRAN (R 4.3.0)
##  openssl       2.1.1   2023-09-25 [1] CRAN (R 4.3.1)
##  pillar        1.9.0   2023-03-22 [1] CRAN (R 4.3.0)
##  pkgconfig     2.0.3   2019-09-22 [1] CRAN (R 4.3.0)
##  purrr       * 1.0.2   2023-08-10 [1] CRAN (R 4.3.0)
##  R6            2.5.1   2021-08-19 [1] CRAN (R 4.3.0)
##  rlang         1.1.3   2024-01-10 [1] CRAN (R 4.3.1)
##  rmarkdown     2.25    2023-09-18 [1] CRAN (R 4.3.1)
##  rprojroot     2.0.4   2023-11-05 [1] CRAN (R 4.3.1)
##  rstudioapi    0.15.0  2023-07-07 [1] CRAN (R 4.3.0)
##  sessioninfo   1.2.2   2021-12-06 [1] CRAN (R 4.3.0)
##  sys           3.4.2   2023-05-23 [1] CRAN (R 4.3.0)
##  tibble        3.2.1   2023-03-20 [1] CRAN (R 4.3.0)
##  usethis       2.2.2   2023-07-06 [1] CRAN (R 4.3.0)
##  utf8          1.2.4   2023-10-22 [1] CRAN (R 4.3.1)
##  vctrs         0.6.5   2023-12-01 [1] CRAN (R 4.3.1)
##  xfun          0.41    2023-11-01 [1] CRAN (R 4.3.1)
##  yaml          2.3.8   2023-12-11 [1] CRAN (R 4.3.1)
## 
##  [1] /Users/283204f/Library/R/arm64/4.3/library
##  [2] /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources/library
## 
## ──────────────────────────────────────────────────────────────────────────────

adamhsparks/nasapower documentation built on May 5, 2024, 9:54 p.m.