Ivan Calandra , 2025-01-06, 17:21:39
- How to cite
- Contents
- How to run in your browser or download and run locally
- License
- Contributions
- References
This repository contains the data and code for our paper:
Fuentes R, Marreiros J, Kullmer O, Gneisinger G, Ono R, Aziz N, Sriwigati, Geromiano M, Clamor WL, Pawlik A & Calandra I (to be submitted). Making the cut: experimental bamboo processing using chert tools from Island Southeast Asia. Name of journal: TBA https://doi.org/xxx/xxx
Please cite this compendium as:
Fuentes R, Marreiros J, Kullmer O, Gneisinger G, Ono R, Aziz N, Sriwigati, Geromiano M, Clamor WL, Pawlik A & Calandra I (2025). Compendium of R code and data for Making the cut: experimental bamboo processing using chert tools from Island Southeast Asia. Accessed 06 Jan 2025. Online at https://doi.org/10.5281/zenodo.14605779
This README.md file has been created by rendering the README.qmd file.
The DESCRIPTION file contains information about the version, author, license and packages. For details on the license, see the LICENSE file.
The ISEA.usewear.Rproj file is the RStudio project file.
The analysis directory contains all files related to the R analysis. It is composed of the following folders:
- 📁 derived_data: output data generated during the analysis (scripts 1a, 2, 3a).
- 📁 plots: plots generated during the analyses (scripts 1b, 2 and 3c).
- 📁 raw_data: input data used in the analyses (scripts 2 and 3a).
- 📁 scripts: scripts used to run the analyses. See below for details.
- 📁 stats: summary statistics generated during the analyses (scripts 2 and 3b).
The scripts directory contains the following files:
- ISEA_0_CreateRC.Rmd: script used to create this research compendium - it is not part of the analysis per se and is not meant to be run again. Rendered to MD and HTML files; the references are exported to a BIB file.
- ISEA_1a_Smarttester-import.Rmd: script to import the sensors’ data from the robotic experiment with the Smarttester material tester. Rendered to MD and HTML files; the references are exported to a BIB file.
- ISEA_1b_Smarttester-plot.Rmd: script to plot the sensors’ data from the robotic experiment with the Smarttester. Rendered to MD (+ associated PNG files of the plots in the folder ISEA_1b_Smarttester-plot_files) and HTML files; the references are exported to a BIB file.
- ISEA_2_Weights.Rmd: script to import and plot the tools’ weights before and after the experiments. Rendered to MD (+ associated PNG files of the plots in the folder ISEA_2_Weights_files) and HTML files; the references are exported to a BIB file.
- ISEA_3a_STA-import.Rmd: script to import the raw, input data from the surface texture analysis (STA). Rendered to MD and HTML files; the references are exported to a BIB file.
- ISEA_3b_STA-stats.Rmd: script to compute group-wise summary statistics for the STA data. Rendered to MD and HTML files; the references are exported to a BIB file.
- ISEA_3c_STA-plots.Rmd: script to produce plots for the STA data. Rendered to MD (+ associated PNG files of the plots in the folder ISEA_3c_STA-plots_files) and HTML files; the references are exported to a BIB file.
Note that the HTML files are not rendered nicely on GitHub; you need to
download them and open them with your browser. Use the MD files to view
on GitHub. However, MD files do not have all functionalities of HTML
files (numbered sections, floating table of content). I therefore
recommend using the HTML files.
To download an HTML file from GitHub, first display the “raw” file and
then save it as HTML.
Alternatively, use GitHub & BitBucket HTML Preview to render it directly.
The renv.lock file is the lockfile describing the state of the R project’s library. It is associated to the activation script and the R project’s library. All these files have been created using the package renv.
See the section Contributions for details on the CONDUCT.md and CONTRIBUTING.md files.
This research compendium has been developed using the statistical programming languages R. To work with the compendium, you will need to install on your computer the R software and RStudio Desktop.
To work locally with the R analysis, either from the ZIP archive or from cloning the GitHub repository to your computer:
- open the ISEA.usewear.Rproj file in RStudio; this takes some time the first time.
- run
renv::status()and thenrenv::restore()to restore the state of your project from renv.lock.
Using the package renv implies that installing, removing and updating
packages is done within the project. In other words, all the packages
that you install/update while in a project using renv will not be
available in any other project. If you want to globally
install/remove/update packages, make sure you close the project first.
You can also download the compendium as a ZIP
archive.
Alternatively, if you use GitHub, you can fork and
clone the repository to
your account. See also the CONTRIBUTING.md file.
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
See also License file in the repository.
Author: Ivan Calandra
We welcome contributions from everyone. Before you get started, please see our contributor guidelines. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Soler S. 2022.cc-licenses: Creative Commons Licenses for GitHub Projects. Available at https://github.com/santisoler/cc-licenses (accessed September 27, 2022)