Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
caiohamamura committed Oct 25, 2023
1 parent 12f92c7 commit 035cad7
Show file tree
Hide file tree
Showing 9 changed files with 136 additions and 109 deletions.
7 changes: 2 additions & 5 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,11 @@ export(clipLevel2BPAVDProfile)
export(clipLevel2BPAVDProfileGeometry)
export(clipLevel2BVPM)
export(clipLevel2BVPMGeometry)
export(close)
export(gedi.fullwaveform)
export(gedi.level1b)
export(gedi.level2a)
export(gedi.level2b)
export(gediDownload)
export(gediWFMetrics)
export(gediWFSimulator)
export(gedifinder)
export(getLevel1BGeo)
export(getLevel1BWF)
Expand All @@ -33,7 +30,6 @@ export(getLevel2BPAVDProfile)
export(getLevel2BVPM)
export(gridStatsLevel2AM)
export(gridStatsLevel2BVPM)
export(plot)
export(plotPAIProfile)
export(plotPAVDProfile)
export(plotWFMetrics)
Expand All @@ -46,6 +42,8 @@ exportClasses(gedi.fullwaveform)
exportClasses(gedi.level1b)
exportClasses(gedi.level2a)
exportClasses(gedi.level2b)
exportMethods(close)
exportMethods(plot)
import(curl)
import(data.table)
import(fs)
Expand Down Expand Up @@ -77,4 +75,3 @@ importFrom(hdf5r,H5File)
importFrom(stats,na.omit)
importFrom(stats,quantile)
importFrom(stats,setNames)
useDynLib(rGEDI)
7 changes: 6 additions & 1 deletion R/gridStatsLevel2AM.R
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@
#' }
#'
#' #' Computing a serie of GEDI metrics
#' ZTstats <- gridStatsLevel2AM(level2AM = level2AM, func = mySetOfMetrics(elev_highestreturn), res = 0.005)
#' ZTstats <- gridStatsLevel2AM(
#' level2AM = level2AM,
#' func = mySetOfMetrics(elev_highestreturn),
#' res = 0.005
#' )
#' head(ZTstats)
#'
#' #' Computing the maximum of RH100 only
Expand All @@ -61,6 +65,7 @@
#' @export
gridStatsLevel2AM <- function(level2AM, func, res = 0.5) {
requireNamespace("data.table")
cells <- NA
# this code has been adapted from the grid_metrics function in lidR package (Roussel et al. 2019)
# https://github.com/Jean-Romain/lidR/blob/master/R/grid_metrics.r

Expand Down
7 changes: 6 additions & 1 deletion R/gridStatsLevel2BVPM.R
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@
#' }
#'
#' #' Computing a serie of statistics of GEDI derived canopy cover
#' cover_stats <- gridStatsLevel2BVPM(level2BVPM = level2BVPM, func = mySetOfMetrics(cover), res = 0.005)
#' cover_stats <- gridStatsLevel2BVPM(
#' level2BVPM = level2BVPM,
#' func = mySetOfMetrics(cover),
#' res = 0.005
#' )
#' head(cover_stats)
#'
#' #' Computing the max of the Total Plant Area Index only
Expand All @@ -60,6 +64,7 @@
#' @export
gridStatsLevel2BVPM <- function(level2BVPM, func, res) {
requireNamespace("data.table")
cells <- NA
# this code has been adapted from the grid_metrics function in lidR package (Roussel et al. 2019)
# https://github.com/Jean-Romain/lidR/blob/master/R/grid_metrics.r

Expand Down
3 changes: 2 additions & 1 deletion man/gedifinder.Rd

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

46 changes: 25 additions & 21 deletions man/gridStatsLevel2AM.Rd

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

46 changes: 25 additions & 21 deletions man/gridStatsLevel2BVPM.Rd

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

35 changes: 20 additions & 15 deletions man/plot.Rd

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

48 changes: 26 additions & 22 deletions man/polyStatsLevel2AM.Rd

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

Loading

0 comments on commit 035cad7

Please sign in to comment.