The MFishBTdat
package contains a large collection of biological archives datasets of migratory fish. These datasets have important applications to biogeochemistry and ecosystem science. The development of this package is inspired by metadat.
The development version of the package can be installed with:
install.packages("remotes")
remotes::install_github("Otoliths/MFishBTdat")
This builds the package from source based on the current version on GitHub.
A listing of all datasets in the package can be obtained with help(package = MFishBTdat)
. Each dataset is also tagged with one or multiple concept terms. These concept terms refer to various aspects of a dataset, such as the biogeochemical tags, the biological archives/structures, the microchemical/isotopic elements, and the FAO major fishing areas that can be illustrated with the dataset. The dat_search()
function can be used to search among the existing datasets in the package based on their concept terms or based on a full-text search of their corresponding help files.
You can also read the documentation online at https://Otoliths.github.io/MFishBTdat/ (where the output from the example analyses corresponding to each dataset is provided).
We welcome contributions of new datasets to the package. For each dataset, there must be a citable reference, ideally in a peer-reviewed journal or publication. The general workflow for contributing a new dataset is as follows:
MFishBTdat
package in R in the usual manner (i.e., install_github("Otoliths/MFishBTdat")
).data-raw
directory. The file should be named bt.<author>.<year>.<ext>
, where <author>
is the last name of the first author of the publication from which the data come, <year>
is the publication year, and <ext>
is the file extension (e.g., .txt
, .csv
).data-raw
directory named bt.<author>.<year>.r
that reads in the data, possibly does some data cleaning/processing, and then saves the dataset to the data
directory (using save()
), with name bt.<author>.<year>.rda
.MFishBTdat
package (i.e., library(MFishBTdat)
), and then run the dat_prepare()
function (either set the working directory to the location of the source package beforehand or use the pkgdir
argument of the dat_prepare()
function to specify the source package location).man
directory, named bt.<author>.<year>.Rd
. Edit the help file, adding the title and a short description of the dataset in general, a description of each variable in the dataset, further details on the dataset (e.g., the field of research, how the data was collected, the purpose of the dataset or what it was used for, the effect size or outcome measure used in the analysis, the types of analyses/models that can be illustrated with the dataset), a reference for the source of the dataset, one or multiple concept terms, the name and email address of the contributor of the dataset, and (optionally) example code to illustrate the analysis of the dataset.bt.<author>.<year>.<ext>
, bt.<author>.<year>.r
, bt.<author>.<year>.rda
, and bt.<author>.<year>.Rd
files and open up a new issue at GitHub, attaching the zip file..txt
or .csv
format, along with a meta-data file (format doesn’t matter) that includes the information described above.If you use these data, please cite both the MFishBTdat
package (see citation("MFishBTdat")
for the reference) and the original source of the data as given under the help file of a dataset.
If you think you have found an error in an existing dataset or a bug in the package in general, please go to https://github.com/Otoliths/MFishBTdat/issues and open up a new issue.