bug fixes

Author: Peter-T-Ruehr

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: forceR
 Title: Force Measurement Analyses
-Version: 1.0.3
+Version: 1.0.4
 Description: An R package for time series cleaning and analysis. forceR can be used for any time series measurements, but was initially written and optimize to deal with bite force measurements of insects. forceR includes a full workflow to load, plot and crop data, correct amplifier and baseline drifts, identify individual peak shapes, rescale (normalize) peak curves, and find best polynomial fits to describe and analyze force curve shapes.
 License: MIT + file LICENSE
 URL: https://github.com/Peter-T-Ruehr/forceR

R/peak_finding.R

@@ -44,10 +44,15 @@
 #'  as orange points is saved as one PDF per measurement at `path.plots`.
 #'
 #' @examples
+#' require(dplyr)
 #' # Using the forceR::df.all.200.tax dataset:
 #'
+#' # reduce dataset
+#' df.all.200.tax_filtered <- df.all.200.tax %>%
+#'   filter(species == "species_A")
+#'
 #' # find strongest peaks
-#' peaks.df <- find_strongest_peaks(df = df.all.200.tax,
+#' peaks.df <- find_strongest_peaks(df = df.all.200.tax_filtered,
 #'                                  no.of.peaks = 5,
 #'                                  print.to.pdf = FALSE)
 #'

README.md

@@ -14,8 +14,6 @@ The package `forceR` has originally been written for insect bite force data prep
 * reduction of curves to 100 time steps each
 * finding of best polynomial fits to describe all curves
 
-
-
 ### Installation
 
 #### This is the development version of `forceR`
@@ -30,12 +28,12 @@ devtools::install_github("https://github.com/Peter-T-Ruehr/forceR")
 ```
 
 #### Official release
-To install the development version of `forceR` from [GitHub](https://github.com/Peter-T-Ruehr/forceR) use the following command:
+To install the development version of `forceR` from [GitHub](https://github.com/Peter-T-Ruehr/forceR) use the following command (not yet valid):
 ```
 install.packages('forceR')
 ```
 
 ### Citation
 If you use this package, please cite the original publication (currently under review):
 
-Rühr, PT & Blanke, A (**2021**): `forceX` and `forceR`: a mobile setup and R package to measure and analyze a wide range of animal closing forces. *XXX* **XXX**: pp.XX-XX. doi: XXX
+Rühr, PT & Blanke, A (**2022**): `forceX` and `forceR`: a mobile setup and R package to measure and analyze a wide range of animal closing forces. *XXX* **XXX**: pp.XX-XX. doi: XXX