In FlukeAndFeather/cetaceanbcg: Cetacean Heart Beats Detected by Ballistocardiogram

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
# Please put your title here to include it in the file below.
Title <- "An accelerometer-derived ballistocardiogram method for detecting heartrates in free-ranging marine mammals"
Authors <- "Czapanskiy, M. F., Ponganis, P. J., Fahlbusch, J. A., and Goldbogen, J. A."

cetaceanbcg

This repository contains the data and code for our paper:

r Authors (in press). r Title.

How to cite

Following publication, please cite this compendium as:

r Authors (r format(Sys.Date(), "%Y")). Compendium of R code and data for "r Title". Accessed r format(Sys.Date(), "%d %b %Y").

Contents

The analysis directory contains:

• :file_folder: paper: R Markdown source document for manuscript. Includes code to reproduce the figures and tables generated by the analysis. It also has a rendered version, paper.docx, suitable for reading (the code is replaced by figures and tables in this file)
• :file_folder: data: Data used in the analysis.
• :file_folder: figures: Plots and other illustrations
• :file_folder: supplementary-materials: Supplementary materials including notes and other documents prepared and collected during the analysis.

How to download and run locally

This research compendium has been developed using the statistical programming language R. To work with the compendium, you will need installed on your computer the R software itself and optionally RStudio Desktop.

You can download the compendium as a zip from from this URL: main.zip. After unzipping: - open the .Rproj file in RStudio - run devtools::install() to ensure you have the packages this analysis depends on (also listed in the DESCRIPTION file). - finally, open analysis/paper/paper.Rmd and knit to produce the paper.docx, or run rmarkdown::render("analysis/paper/paper.Rmd") in the R console

Licenses

Text and figures : CC-BY-4.0

Code : See the DESCRIPTION file

Data : CC-0 attribution requested in reuse

FlukeAndFeather/cetaceanbcg documentation built on July 7, 2022, 12:36 p.m.