Skip to content

Description & License Cleanup. Declutter top level #34

@danmcgraw94

Description

@danmcgraw94

Migrate license to Zero-Clause BSD (0BSD)

HIGH priority with public facing repo
Currently the repo has two license files (LICENSE and LICENSE.note) under BSD_3_clause. Migrate to the simpler Zero-Clause BSD (0BSD) license per HS request. 0BSD is not a commonly used CRAN package license. Likely need License: file LICENSE in DESCRIPTION and carry the full 0BSD text in LICENSE
https://opensource.org/license/0bsd

Add ORCID IDs to Authors@R in DESCRIPTION

Several contributors have ORCID iDs that should be added to the Authors@R field. The comment argument in person() accepts a named character vector, use ORCID iDs
(ORCID = "xxxx-xxxx-xxxx-xxxx")
Contributors with ORCID iDs to add: McGraw, Verdin, C. Haden Smith, Hartke, Niblett, Gonzalez

Address R CMD check NOTEs and top-level clutter

checking top-level files ... NOTE Non-standard file/directory found at top level: 'CONTRIBUTING.md'
move CONTRIBUTING.md into .github/
Timestamp note is local artifact of network security

Declutter

build artifacts generated by devtools::install(). Add all 3 to .gitignore
doc/ — built vignette .html, .R, and .Rmd output (~12 MB); vignette sources belong in vignettes/ only
Meta/ — contains vignette.rds, a build index companion to doc/
Results/ — project output folder; not an R package directory

Set up dynamic version and year for citation

inst/CITATION
Replace hardcoded version and year with dynamic values as above

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationpriority: highBlocks release or breaks core functionality

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions