Commit 291dce37 authored by Johannes Knoch's avatar Johannes Knoch
Browse files

documentation adjusted

parent f26ecc6c
......@@ -11,7 +11,7 @@ saveSamplePoints(
output_format = c("shp", "geojson"),
ref_samples,
ref_switch,
threshold,
num_models,
dummy_raster
)
}
......@@ -28,14 +28,14 @@ saveSamplePoints(
\item{ref_switch}{vector with switch values}
\item{threshold}{threshold}
\item{num_models}{number of models used for the classification of a habitat}
\item{dummy_raster}{raster with probabilities for each pixel}
}
\value{
ESRI shapefiles/GeoJSON with name: SamplePoints_step_classname.shp/SamplePoints_step_classname.geojson
\enumerate{
\item Point Shape/GeoJSON represents pixel that belong to selected habitat type and can be used as reference for further model building.
\item Point Shape/GeoJSON represents the pixels which were used to train the models for that habitat.
ESRI shapefiles have the same CRS as the input raster. GeoJSON files are in the standard CRS of GeoJSON (EPSG:4326).
}
}
......
......@@ -2,7 +2,7 @@
% Please edit documentation in R/save_files.r
\name{writeOutSamples}
\alias{writeOutSamples}
\title{Sample Collection for Habitat Types}
\title{Selected Sample Collection for Habitat Types}
\usage{
writeOutSamples(in_path, step, class_name, output_format = c("shp", "geojson"))
}
......@@ -18,10 +18,12 @@ writeOutSamples(in_path, step, class_name, output_format = c("shp", "geojson"))
\value{
ESRI shapefiles/GeoJSON with name: SamplePoints_step_classname.shp/SamplePoints_step_classname.geojson
\enumerate{
\item Point Shape/GeoJSON represents pixel that belong to selected habitat type and can be used as reference for further model building.
\item Point Shape/GeoJSON represents the pixels which belong to selected habitat type and can be used as reference for further model building.
ESRI shapefiles have the same CRS as the input raster. GeoJSON files are in the standard CRS of GeoJSON (EPSG:4326).
}
}
\description{
Writes out a set of samples (SpatialPointsDataFrame) into ESRI shapefiles or a GeoJSON file for a selected habitat type. Each point represents a valid sample location that identifies the selected habitat type.
Writes out a set of samples (SpatialPointsDataFrame) into ESRI shapefiles or a GeoJSON file for a selected habitat type.
Each point represents a valid sample location that identifies the selected habitat type. Only those points are selected
which lay in the habitat type selected by the user's input threshold.
}
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