Commit 9ab07e46 authored by Romulo Pereira Goncalves's avatar Romulo Pereira Goncalves
Browse files

Align documentation

parent a3700074
......@@ -20,12 +20,11 @@
#' @param n_classes total number of classes (habitat types) to be separated
#' @param multiTest number of test runs to compare different probability outputs
#' @param RGB rgb channel numbers for image plot
#' @param overwrite overwrite the results file
#' @param save_runs if it saves the Habitat object or not (default TRUE)
#' @param parallel_mode run loops using all available cores
#' @param max_num_cores maximum number of cores for parallelism
#' @param overwrite overwrite the KML and raster files from previous runs (default TRUE)
#' @param save_runs to save to disk and memory the Habitat object or not (default TRUE)
#' @param parallel_mode run loops using all available cores (default FALSE)
#' @param max_num_cores maximum number of cores for parallelism (default 5)
#' @param plot_on_browser plot on the browser or inline in a notebook (default TRUE)
#'
#' @return 4 files per step:
#' 1) Habitat type probability map as geocoded *.kml layer and *.tif raster files and *.png image output
......
......@@ -67,13 +67,13 @@ multi_Class_Sampling(
\item{RGB}{rgb channel numbers for image plot}
\item{overwrite}{overwrite the results file}
\item{overwrite}{overwrite the KML and raster files from previous runs (default TRUE)}
\item{save_runs}{if it saves the Habitat object or not (default TRUE)}
\item{save_runs}{to save to disk and memory the Habitat object or not (default TRUE)}
\item{parallel_mode}{run loops using all available cores}
\item{parallel_mode}{run loops using all available cores (default FALSE)}
\item{max_num_cores}{maximum number of cores for parallelism}
\item{max_num_cores}{maximum number of cores for parallelism (default 5)}
\item{plot_on_browser}{plot on the browser or inline in a notebook (default TRUE)}
}
......
......@@ -48,8 +48,11 @@ The demo shows how to classify 7 classes using a Sentinel 2 image.
n_classes # total number of classes (habitat types) to be separated
multiTest # number of test runs to compare different probability output
RGB # pallet colors for the interactive plots
overwrite # overwrite the KML and raster files from previous runs
parallel_mode # run loops using all available cores
overwrite # overwrite the KML and raster files from previous runs (default TRUE)
save_runs # to save to disk and memory the Habitat object or not (default TRUE)
parallel_mode # run loops using all available cores (default False
max_num_cores # maximum number of cores for parallelism (default 5)
plot_on_browser # plot on the browser or inline in a notebook (default TRUE)
)
```
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment