updt package

Author: Flavjack

.Rbuildignore

@@ -28,3 +28,4 @@ setup.r
 ^vignettes/articles$
 ^\.positai$
 ^\.claude$
+^README\.qmd$

README.Rmd

@@ -1,71 +1,88 @@
 
-<!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# inti <img src="man/figures/logo.png" align="right" width="200" />
+# inti
 
-<!-- badges: start -->
-
-[![CRAN
-status](https://www.r-pkg.org/badges/version/inti)](https://CRAN.R-project.org/package=inti)
+[![CRAN](https://img.shields.io/cran/v/inti.png)](https://cran.r-project.org/package=inti)
 [![DOI](https://zenodo.org/badge/82401374.svg)](https://zenodo.org/badge/latestdoi/82401374)
 [![R-CMD-check](https://github.com/Flavjack/inti/workflows/R-CMD-check/badge.svg)](https://github.com/Flavjack/inti/actions)
-[![CRAN RStudio mirror
-downloads](https://cranlogs.r-pkg.org/badges/grand-total/inti?color=brightgreen)](https://r-pkg.org/pkg/inti)
-<!-- badges: end -->
+[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/inti?color=brightgreen.png)](https://r-pkg.org/pkg/inti)
+
+The **inti** package is part of the **inkaverse** project, which
+develops tools and workflows for plant science, experimental design,
+data analysis, and scientific writing. The package supports researchers
+during experiment planning and field data collection through **Tarpuy**,
+statistical analysis and visualization through **Yupana**, and the
+preparation of scientific outputs.
 
-The ‘inti’ package is part of the ‘inkaverse’ project for developing
-different procedures and tools used in plant science and experimental
-designs. The mean aim of the package is to support researchers during
-the planning of experiments and data collection ‘tarpuy()’, data
-analysis and graphics ‘yupana()’, and technical writing. Learn more
-about the ‘inkaverse’ project at <https://inkaverse.com/>.
+More information about the project is available at
+<https://inkaverse.com/>.
 
 ## Installation
 
-To install the stable version from
-[CRAN](https://cran.r-project.org/package=inti):
+The stable version of **inti** can be installed from CRAN:
 
 ``` r
 install.packages("inti")
 ```
 
-To install the latest development version directly from
-[GitHub](https://github.com/flavjack/inti):
+To install the latest development version directly from GitHub, it is
+recommended to use **pak**:
+
+``` r
+if (!requireNamespace("pak", quietly = TRUE)) {
+  install.packages("pak")
+}
+
+pak::pkg_install("flavjack/inti")
+```
+
+To install a specific version from CRAN (e.g., version 0.4.4):
 
 ``` r
-if (!require("remotes"))
-  install.packages("remotes")
-remotes::install_github("flavjack/inti")
+if (!requireNamespace("pak", quietly = TRUE)) {
+  install.packages("pak")
+}
+
+pak::pkg_install("inti@0.4.4")
 ```
 
-If you need install an specific version:
+After installation, load the package:
 
 ``` r
-if (!require("remotes"))
-  install.packages("remotes")
-remotes::install_version("inti", version = "0.4.4")
+library(inti)
 ```
 
-## Shiny apps
+## Shiny Applications
+
+The **inti** package includes two Shiny applications that provide
+graphical interfaces for experimental design, data management,
+statistical analysis, and result visualization.
 
-If is the first time running any of the apps consider install the app
+### Installing Application Dependencies
+
+The first time you run any of the applications, install the required
 dependencies:
 
 ``` r
 inti::yupana(dependencies = TRUE)
 ```
 
-After install the package and the app dependencies also you can access
-to the apps through the Addins list in Rstudio or running the following
-code:
+This step only needs to be performed once.
+
+### Launching the Applications
+
+The applications can be accessed directly from the **RStudio Addins**
+menu or launched from the R console.
 
-### Yupana
+**Yupana** is an interactive environment for statistical analysis and
+visualization of experimental data.
 
 ``` r
 inti::yupana()
 ```
 
-### Tarpuy
+**Tarpuy** is an interactive platform for experimental planning,
+field-book generation, treatment organization, and data management.
 
 ``` r
 inti::tarpuy()

README.md

@@ -0,0 +1,105 @@
+---
+format:
+  gfm:
+    output-file: README.md
+editor: source
+---
+
+```{r}
+#| include: false
+
+knitr::opts_chunk$set(
+  fig.align = "center",
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+# inti
+
+[![CRAN](https://img.shields.io/cran/v/inti)](https://cran.r-project.org/package=inti)
+[![DOI](https://zenodo.org/badge/82401374.svg)](https://zenodo.org/badge/latestdoi/82401374)
+[![R-CMD-check](https://github.com/Flavjack/inti/workflows/R-CMD-check/badge.svg)](https://github.com/Flavjack/inti/actions)
+[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/inti?color=brightgreen)](https://r-pkg.org/pkg/inti)
+
+The **inti** package is part of the **inkaverse** project, which develops tools and workflows for plant science, experimental design, data analysis, and scientific writing. The package supports researchers during experiment planning and field data collection through **Tarpuy**, statistical analysis and visualization through **Yupana**, and the preparation of scientific outputs.
+
+More information about the project is available at <https://inkaverse.com/>.
+
+## Installation
+
+The stable version of **inti** can be installed from CRAN:
+
+```{r}
+#| eval: false
+
+install.packages("inti")
+```
+
+To install the latest development version directly from GitHub, it is recommended to use **pak**:
+
+```{r}
+#| eval: false
+
+if (!requireNamespace("pak", quietly = TRUE)) {
+  install.packages("pak")
+}
+
+pak::pkg_install("flavjack/inti")
+```
+
+To install a specific version from CRAN (e.g., version 0.4.4):
+
+```{r}
+#| eval: false
+
+if (!requireNamespace("pak", quietly = TRUE)) {
+  install.packages("pak")
+}
+
+pak::pkg_install("inti@0.4.4")
+```
+
+After installation, load the package:
+
+```{r}
+#| eval: false
+
+library(inti)
+```
+
+## Shiny Applications
+
+The **inti** package includes two Shiny applications that provide graphical interfaces for experimental design, data management, statistical analysis, and result visualization.
+
+### Installing Application Dependencies
+
+The first time you run any of the applications, install the required dependencies:
+
+```{r}
+#| eval: false
+
+inti::yupana(dependencies = TRUE)
+```
+
+This step only needs to be performed once.
+
+### Launching the Applications
+
+The applications can be accessed directly from the **RStudio Addins** menu or launched from the R console.
+
+**Yupana** is an interactive environment for statistical analysis and visualization of experimental data.
+
+```{r}
+#| eval: false
+
+inti::yupana()
+```
+
+**Tarpuy** is an interactive platform for experimental planning, field-book generation, treatment organization, and data management.
+
+```{r}
+#| eval: false
+
+inti::tarpuy()
+```