---
title: "Pot-ken"
format: gfm
editor: visual
---

*Pot-ken means "heat" in* Selk'nam language / Pot-ken significa *calor* en Selk'nam

*A reproducible R workflow for energy density determination using a Parr 6725 calorimeter/* Flujo de trabajo reproducible en R para la determinación de densidad energética mediante un calorímetro Parr 672**5**

Developed by [Cintia Fraysse](https://www.researchgate.net/profile/Cintia-Fraysse?ev=hdr_xprf) and [Claudia Boy](https://www.researchgate.net/profile/Claudia-Boy) in [Laboratorio de Ecología, Fisiología y Evolución de Organismos Acuáticos](https://www.researchgate.net/lab/Ecologia-Fisiologia-y-Evolucion-de-Organismos-Acuaticos-Daniel-A-Fernandez)

Licence information at the end of this file.

## **Overview of the workflow/Descripción general del flujo de trabajo**

### English

This repository provides an automated and reproducible pipeline to process raw output files generated by a Parr 6725 bomb calorimeter.

The workflow:

-   assigns column names to calorimeter output files using a template file,

-   compiles all determinations into a single dataset,

-   removes non-essential variables,

-   converts binary and numeric codes into their corresponding descriptive labels,

-   calculates energy density values on a dry mass basis (DM) and ash-free dry mass basis (AFDM)

### Español

Este repositorio proporciona un pipeline automatizado y reproducible para procesar los archivos de salida generados por un calorímetro de bomba Parr 6725.

El código:

-   asigna automáticamente los nombres de las columnas a los archivos de salida del calorímetro utilizando el archivo `RunDataTemplate.csv`,

-   integra todas las determinaciones individuales en un único conjunto de datos,

-   elimina variables no esenciales,

-   traduce los códigos binarios y numéricos a sus etiquetas descriptivas correspondientes, y

-   calcula valores de densidad energética con y sin corrección por contenido de cenizas.

## Repository structure

POT-KEN/

├── POT-KEN.Rproj

├── Determinations/ *#empty by default – user input* /vacía - cargar los archivos generados por el equipo

├── Example/ *#example dataset for Usage example*/solo para ejemplo de uso

├── docs

├── R/

│ └── potken_workflow.R

## Requirements/ Requerimientos

-   R (≥ 4.0)

-   Packages: `readr`, `dplyr`, `here`

    ```{r, eval = FALSE}
    install.packages ("readr") 
    install.packages ("dplyr") 
    install.packages ("here")  

    library(readr) 
    library(dplyr) 
    library(here)
    ```

File paths are handled using the `here` package to ensure platform-independent execution.

## Usage/Uso

### English

1.  Open the project using `.POT-KEN.Rproj` file.

2.  Place all input files (`.det.finl.csv`, `Ashes.csv`, and `RunDataTemplate.csv`) in the `Determinations/` folder

3.  Complete the `Ashes.csv` file (in the `Determinations/` folder) following these guidelines:

    -   **Sample ID**: must match the same ID assigned to the sample at the time of combustion.

    -   **Ashes_caps**: ash weight in grams after combustion, including the sample capsule.

    -   **Caps**: weight in grams of the empty capsule.

    -   **Ashes**: difference between `Ashes_caps` and `Caps`.

    -   **Spike_Ashes**: ash weight in grams of the vehicle (spike) used during combustion, **only when applicable**; otherwise, this field must be filled with `0`.

4.  Run `R/potken_workflow.R`.

### Español

1.  Abrir el proyecto usando el proyecto `.POT-KEN.Rproj`.

2.  Guardar todos los archivos de entrada (`.det.finl.csv`, `Ashes.csv` y `RunDataTemplate.csv`) en la carpeta `Determinations/`.

3.  Completar el archivo `Ashes.csv` siguiendo las pautas:

    -   **Sample ID**: debe coincidir con el ID asignado a la muestra al momento de la combustión.

    -   **Ashes_caps**: peso en gramos de las cenizas al finalizar la combustión, incluyendo la cápsula de soporte.

    -   **Caps**: peso en gramos de la cápsula soporte vacía.

    -   **Ashes**: diferencia entre `Ashes_caps` y `Caps`.

    -   **Spike_Ashes**: peso en gramos de las cenizas del vehículo (spike) utilizado durante la combustión, **solo en los casos en que se haya utilizado**; de lo contrario, completar con `0`.

4.  Correr `R/potken_workflow.R`.

## Example Usage

For demonstration purposes, the repository includes an `Example/` folder containing a complete set of input files.

To test the workflow with example data, set in the script:

```{r, eval = FALSE}

path_ <- here("Example")
```

## Citation

If you use this workflow or parts of it in your research, please cite:

Fraysse, C., & Boy, C. C. (2026). Pot-ken: a reproducible R workflow for energy density determination using a Parr 6725 bomb calorimeter (v1.3.1). Zenodo. <https://doi.org/10.5281/zenodo.18200628>
