From f3b2471bf9579a43003d3fdf3259db2597cce77f Mon Sep 17 00:00:00 2001 From: khufkens Date: Tue, 3 Oct 2023 22:19:39 +0300 Subject: [PATCH] docs --- man/stk_map.Rd | 21 +++++++++++++++++++++ man/stk_mask.Rd | 2 +- man/stk_profile.Rd | 2 ++ 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 man/stk_map.Rd diff --git a/man/stk_map.Rd b/man/stk_map.Rd new file mode 100644 index 0000000..ad2d130 --- /dev/null +++ b/man/stk_map.Rd @@ -0,0 +1,21 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/stk_map.R +\name{stk_map} +\alias{stk_map} +\title{Plot skytrackr results} +\usage{ +stk_map(df, buffer, bbox) +} +\arguments{ +\item{df}{a data frame with locations produced by skytrackr()} + +\item{buffer}{a land mask buffer value} + +\item{bbox}{a bounding box} +} +\value{ +a ggplot map of tracked locations +} +\description{ +Create a map of estimated locations +} diff --git a/man/stk_mask.Rd b/man/stk_mask.Rd index 83da8eb..446734e 100644 --- a/man/stk_mask.Rd +++ b/man/stk_mask.Rd @@ -4,7 +4,7 @@ \alias{stk_mask} \title{A land mask} \usage{ -stk_mask(buffer = 1.5) +stk_mask(buffer = 0) } \arguments{ \item{buffer}{buffer in degrees} diff --git a/man/stk_profile.Rd b/man/stk_profile.Rd index bdd4f16..fa77032 100644 --- a/man/stk_profile.Rd +++ b/man/stk_profile.Rd @@ -22,4 +22,6 @@ a plotly dynamic graph of light levels for a given logger } \description{ Uses plotly to provide a seasonal profile plot +NOTE make this a method class so you can call +plot(data.frame) or plot(df, plotly = TRUE) }