R Observatory: Metrics for x3ptools version 0.0.4

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

x3ptools

0.0.4Package record

Tools for Working with 3D Surface Measurements

0packages depend

3.5Kdownloads / year

74.5%test coverage

8/13flavors OK

Overview

About

Maintained by Heike HofmannCRAN page ↗GitHub ↗Website ↗Issues ↗

The x3p file format is specified in ISO standard 5436:2000 to describe 3d surface measurements. 'x3ptools' allows reading, writing and basic modifications to the 3D surface measurements.

Changes in 0.0.4

major functionality

tmd_to_x3p allows an import of a file in TMD format (natively supported by GelSight instruments) to x3p
x3p_bin_stripes color-shade the mask by row or column-based gradient
x3p_shade_mask color-shade the mask of an x3p by its surface profile
x3p_circle_select interactively select a circle on an x3p surface by selecting three points
update x3p_read and x3p_write to allow vendor specific information

minor functionality

x3p_extract_profile_segments interactive function for drawing lines in segments
added convenience parameter create_dir in x3p_write to create necessary directory structure
x3p_image remove previously deprecated parameters crosscut and ccParam
x3p_image change functionality of parameter size for convenience working with cartridge case scans (make window size proportional to surface), default behavior for bullet scans is unchanged.
updates to documentation

Show all changes in 0.0.4Hide the rest of the changes in 0.0.4

bug fixes

keep mask when averaging in x3p_average
preserve annotations when casting to a data frame

From NEWS.md in the release

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("x3ptools", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("heike/x3ptools")

Development version from heike/x3ptools. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-x3ptools

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled. We list this channel from recorded r2u download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-x3ptools

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-x3ptools

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed). We list this channel from recorded autoCRAN download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

Health

CRAN checks

5NOTE8OK

Check messages

NOTER code for possible problemsr-devel-linux-x86_64-debian-clang, r-devel-linux-x86_64-debian-gcc, r-devel-linux-x86_64-fedora-clang, r-devel-linux-x86_64-fedora-gcc, r-devel-windows-x86_64

Found calls to structure() using deprecated special names:
  x3ptools/tests/testthat/test_x3p_mask_quantile.R (.Dim: 2)
'.Dim' should be changed to 'dim'.

CRAN check page ↗

Slowest check: 2.4 min · r-oldrel-windows-x86_64

Status changes

NOTE8 OK, 5 NOTENow
NOTE11 OK, 2 NOTE2026-07-16
OK13 OK2026-06-09
ERROR12 OK, 1 ERROR2026-06-08
OK14 OK2026-03-10

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 0.0.4

READMEYes · 1,246 wordsVignettesNoNEWSYes · 100% structured · mentions 0.0.4Citation fileNoWebsiteYes · pkgdown

Help pages: 52 (2 internal)
Examples that run: 70%28 run in a plain check · 11 never run · 1 hold no code
Exported functions with examples: 78%
Documented parameters: 98%
Return-value docs: 76%
Help pages citing references: 0%

How these are measured

Downloads

3.5K

CRAN downloads in the past year

Rank #13,094 · ~10/day · ~293/mo

Releases R versions

Daily download trend is not available in this view yet.

27330 days

87890 days

3.5K1 year

Compare downloads with other packages →

Also on102 r2u3 autocran

How downloads are counted

Repository

heike/x3ptools ↗Account: heike

8Stars

5Forks

2Open issues

0Open PRs

2Releases

566Commits

7Commit identities

566 commits · Last activity 2024-10-02 · Default branch at 0.0.4.9000, ahead of CRAN 0.0.4 (checked 2026-10-21)

Responsiveness

How these are sampled

PRs merged (all time): 100%
Median days to close, 50 most recently updated closed issues: 355
Median days to close, 50 most recently updated closed PRs: 0

How these are measured

PracticesBeta

10 development-tooling and community-health practices detected across 5 families in the upstream repository

Checks run against github.com/heike/x3ptools on 2026-10-21.

Continuous integration (2)

GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux

Docs source (4)

README.Rmdpkgdown

GitHub Pages site last deployed 2024-10-02 · The repository has a site deploy workflow

pkgdown site last built 2024-10-02

Coverage (1)

Coverage reporting (Codecov)

CRAN release process (2)

cran-comments.mdCRAN-SUBMISSION

Show all practicesHide 1 practice

Lint, format, editor (1)

RStudio project

How this is detected·Detection ruleset v4 (2026-10-20)

Dependencies

Declared dependencies

22 external dependencies (excludes base and recommended)

Installing x3ptools adds 71 packages (39 with compiled code, 56 MB of source tarballs). Heaviest: stringi 11 MB, bslib 5.6 MB, igraph 4.8 MB.

Depends (1)

R >= 4.0

Imports (17)

MASSdigest xml2 rgl (>= 1.2.0)zoo png readr dplyr pracma assertthat purrr (>= 1.0.0)yaml scales tidyr imager magrittrgrDevices

LinkingTo (0)

none

Suggests (7)

knitr rmarkdown patchwork testthat covr here magick

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

How these are counted

Code & Tests

Datasets

People & History

People (4)

Author

Author

Author · added in 0.0.2

Releases (4)

Pick two releases to compare their code metrics.

R
R 4.6.0 released · 2026-04-24
R
R 4.5.0 released · 2025-04-11
R
R 4.4.0 released · 2024-04-24
0.0.4Latest
record
2024-01-30 · current release · diff ↗ ·
added 5 exports
%>%, tmd_to_x3p, x3p_bin_stripes, x3p_extract_profile_segments, x3p_shade_mask
R
R 4.3.0 released · 2023-04-21
R
R 4.2.0 released · 2022-04-22
unarchivedReturned to CRAN
2021-11-26
0.0.3
record
2021-11-26 · diff ↗ ·
added 26 exports
stl_to_x3p, x3p_add_annotation, x3p_add_mask_layer, x3p_add_meta, x3p_average, x3p_circle_select, x3p_crop, x3p_extract, x3p_extract_profile, x3p_flip_x, x3p_flip_y, x3p_fuzzyselect, x3p_image, x3p_interpolate, x3p_mask_quantile, x3p_read, x3p_read_dat, x3p_read_plux, x3p_rotate, x3p_sample, x3p_select, x3p_snapshot, x3p_transpose, x3p_trim_na, x3p_write, x_flip_x3p
archivedRemoved from CRAN
2021-07-12
policy violation On Internet access
0.0.2
record
2021-06-28 · diff ↗ ·
added 14 exports
x3p_add_grid, x3p_add_hline, x3p_add_legend, x3p_add_mask, x3p_add_vline, x3p_darker, x3p_delete_mask, x3p_get_scale, x3p_lighter, x3p_m_to_mum, x3p_mask_legend, x3p_modify_xml, x3p_scale_unit, x3p_show_xml
R
R 4.1.0 released · 2021-05-18
R
R 4.0.0 released · 2020-04-24
R
R 3.6.0 released · 2019-04-26
R
R 3.5.0 released · 2018-04-23
0.0.1
record
2018-04-05
R
R 3.4.0 released · 2017-04-21

Package metadata

First published: 2018-04-05
Total releases: 4 / 8 yrs
License: MIT + file LICENSE OSI
Minimum R: ≥ 4.0
Bundled data: 290 KB / 2 files
Download size: 3.0 MB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("x3ptools")

Format

Hofmann, H., Hare, E., Krishnan, G., & Vanderplas, S. (2024). x3ptools: Tools for Working with 3D Surface Measurements (Version 0.0.4) [Computer software]. https://doi.org/10.32614/CRAN.package.x3ptools

This package has no citation file, so citation() returns this entry built from DESCRIPTION.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for x3ptools version 0.0.4 [Data set]. HJJB, LLC. Data release v2026-10-25. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-25, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →