Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ramarty committed Nov 25, 2024
1 parent c833d38 commit e939bd3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions R/blackmarbler.R
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ get_nasa_token <- function(username, password) {
#' @param quality_flag_rm Quality flag values to use to set values to `NA`. Each pixel has a quality flag value, where low quality values can be removed. Values are set to `NA` for each value in the `quality_flag_rm` vector. Note that `quality_flag_rm` does not apply for `VNP46A1`. (Default: `NULL`).
#'
#'
#' For `VNP46A1` and `VNP46A2` (daily data):
#' For `VNP46A2` (daily data):
#' - `0`: High-quality, Persistent nighttime lights
#' - `1`: High-quality, Ephemeral nighttime Lights
#' - `2`: Poor-quality, Outlier, potential cloud contamination, or other issues
Expand Down Expand Up @@ -949,7 +949,7 @@ bm_extract <- function(roi_sf,
#' @param quality_flag_rm Quality flag values to use to set values to `NA`. Each pixel has a quality flag value, where low quality values can be removed. Values are set to `NA` for each value in the `quality_flag_rm` vector. Note that `quality_flag_rm` does not apply for `VNP46A1`. (Default: `NULL`).
#'
#'
#' For `VNP46A1` and `VNP46A2` (daily data):
#' For `VNP46A2` (daily data):
#' - `0`: High-quality, Persistent nighttime lights
#' - `1`: High-quality, Ephemeral nighttime Lights
#' - `2`: Poor-quality, Outlier, potential cloud contamination, or other issues
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

<!-- badges: end -->

**BlackMarbleR** is a R package that provides a simple way to use nighttime lights data from NASA's Black Marble. [Black Marble](https://blackmarble.gsfc.nasa.gov) is a [NASA Earth Science Data Systems (ESDS)](https://www.earthdata.nasa.gov) project that provides a product suite of daily, monthly and yearly global [nighttime lights](https://www.earthdata.nasa.gov/learn/backgrounders/nighttime-lights). This package automates the process of downloading all relevant tiles from the [NASA LAADS DAAC](https://www.earthdata.nasa.gov/eosdis/daacs/laads) to cover a region of interest, converting and mosaicing the raw files (in HDF5 format) to georeferenced rasters.
**BlackMarbleR** is a R package that provides a simple way to use nighttime lights data from NASA's Black Marble. [Black Marble](https://blackmarble.gsfc.nasa.gov) is a [NASA Earth Science Data Systems (ESDS)](https://www.earthdata.nasa.gov) project that provides a product suite of daily, monthly and yearly global [nighttime lights](https://www.earthdata.nasa.gov/topics/human-dimensions/nighttime-lights). This package automates the process of downloading all relevant tiles from the [NASA LAADS DAAC](https://ladsweb.modaps.eosdis.nasa.gov/) to cover a region of interest, converting and mosaicing the raw files (in HDF5 format) to georeferenced rasters.

* [Installation](#installation)
* [Bearer token](#token)
Expand Down Expand Up @@ -336,6 +336,6 @@ If `output_location_type = "file"`, the following arguments can be used:

For more information on NASA Black Marble, see:

* [Academic paper](https://www.sciencedirect.com/science/article/pii/S003442571830110X)
* [Substack Post](https://yohaniddawela.substack.com/p/not-all-nightlight-datasets-are-the)
* [Academic paper](https://pdf.sciencedirectassets.com/271745/1-s2.0-S0034425718X00054/1-s2.0-S003442571830110X/am.pdf?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHEaCXVzLWVhc3QtMSJIMEYCIQDArjfr5uSMpM5mQ3cJsNon%2FoLp8Ja8Y9fMXzOKSRTPzwIhAOiZ1vPs4kAYZsWYZF%2BLDQnpqWROIr65WPpEx4AuIVfxKrMFCBkQBRoMMDU5MDAzNTQ2ODY1IgxhyDy7tYJXVUSG9VEqkAWtazYKcwJfrw5bEYNUT7kQyaPJeqsd3Ez33YZAXD9WQ7q8Grsa8xhgfTxwCoPe4fSkxY3juJejdDsEtaXCGWwI6ZOpPstQE29Nkf1fUKBcLPEC0v0Gp5EqPFqJv89HvSYRXEIioqky%2BhAlR0QoVcTsy95v%2BATl%2BY4xIsOpbiRg%2F7nCNx7BGFETK50lsmMUjFeIOVQ8MqBICtUvHbvBl5Xf0Q5cho4Kczji79oo0aTvF35jIl9W0DSuaPpn4Gl%2B2MjwO39Y%2Bt51c9bFe%2F09Ze2drSqzg5i1iT1%2FAPqCcwT4W4FEqg2juiFLOvzXkM404u7J7yFAOnwHi6zg0z97Et77Ucm%2FE6f4%2Fwz9u2A9m9i84d9g2IvLUn9QL22A4QvoFjr5Nc%2BUQTV7j7pyICduk0Bb9gR%2BQrKv%2FRBgaUbgxD8bxM7GLkH0QqBBNVqRctmAIh2x%2F6dEhfXDw08wpnt2sNgH65NvCFQKvQZslo65aZ%2F42qieqs2UvJWycgpAbz6ZczMHN8%2FwjAkQnBF15BZkC2AsW5Xs%2BtXc3%2Fn2rU6TIkGfituf%2B%2F6mtpN1J4migVO6zbV5v2eUFyl26xilNaHV9m0Fse9lD41oQ8Nd3OdrL1fgtGvEzNDjD9tX15B4vZaPqgttfZa0UfFB6pgN1hh4aca0WCwjOgYQzA2Zcaq9RFfeDFNimIqS%2FO78lGzrfQL02ZxfL1E3uOFhD4G4TLoSXU258ik6JUxgy5t91JTHqLL5WlRmp5Q2XdA6g3yj%2F1qnAzz%2FjSXNH8moYEo6vM5MKodUmfIyQos2QChiD65bv0OJi%2BaGM%2Fquenhrkzq4OCtgR7tKDS%2FIxu%2FgdjdzHqlJghx4h9MirQR%2FXacQsbZ0VZMF4DCHx5K6BjqwAe1jQA%2Bu5VqWcrWNf%2BdW%2FFYNxIIiThd22VDZwtwWmgw62g7FaUA%2Bfm7p9MQiXFgVKumiGWuUS6HjUwdpMHU5xZ2M4FW%2FTV8eaIi8jqUwxNyBDdwrMi%2FvlfODzC8xRppZKPflzolxf5doSsEZxcaBVGfmoaep0rK4fYVssKhc3uLbHXSpnxyZqntTv78MXsp1wglcdKj9AIji4RUWDVCyNQaaeXAG8XXF%2BxaY2q5fNyml&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241125T172622Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Credential=ASIAQ3PHCVTYWHTYLA6J%2F20241125%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6703c42a66a14f6bd39b67e40a399f11da2e87467a341381b25853a27127de05&hash=859f116b3c45db6bb47bfc9cc540cc3176dce2b2017448034740575ee68d2ca5&host=68042c943591013ac2b2430a89b270f6af2c76d8dfd086a07176afe7c76c2c61&pii=S003442571830110X&tid=pdf-ac1c6031-531b-4e32-b9e2-9038901e496b&sid=e4ed55ea7138924ddf8b61e7e34b10874ac3gxrqa&type=client)
* [Substack Post](https://www.spatialedge.co/p/not-all-nightlight-datasets-are-the)
* [Webinar](https://appliedsciences.nasa.gov/get-involved/training/english/arset-introduction-nasas-black-marble-night-lights-data)

0 comments on commit e939bd3

Please sign in to comment.