Skip to content

Commit

Permalink
various small checks in preparation for release
Browse files Browse the repository at this point in the history
  • Loading branch information
njtierney committed Dec 12, 2024
1 parent 9cda259 commit b3d9165
Show file tree
Hide file tree
Showing 10 changed files with 96 additions and 12 deletions.
2 changes: 2 additions & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Depends:
Suggests:
knitr,
rmarkdown,
spelling,
testthat (>= 3.0.0)
Encoding: UTF-8
LazyData: true
Expand All @@ -49,3 +50,4 @@ URL: https://github.com/greta-dev/greta.gam, https://greta-dev.github.io/greta.g
BugReports: https://github.com/greta-dev/greta.gam/issues
Roxygen: list(markdown = TRUE)
VignetteBuilder: knitr
Language: en-GB
2 changes: 1 addition & 1 deletion R/evaluate_smooths.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#'
#' @param x a greta array created with greta.gam::smooths
#' @param newdata a dataframe with the same column names and datatypes as that
#' used to create x, with data at which to evauate the smooths
#' used to create x, with data at which to evaluate the smooths
#' @return greta array
#' @author Nick Golding
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/smooths.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#' representing the combined smooth can then be used in a greta model.
#'
#' @param formula a GAM formula representing the smooth terms, as in
#' [mgcv::gam()]. Only the right hand side fo the formula
#' [mgcv::gam()]. Only the right hand side of the formula
#' will be used.
#'
#' @param data a data frame or list containing the covariates required by the
Expand Down
61 changes: 54 additions & 7 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"identifier": "greta.gam",
"description": "A module for greta that lets you use mgcv's smoother functions and formula syntax to define smooth terms for use in a greta model. You can then define your own likelihood to complete the model, and fit it by MCMC. ",
"name": "greta.gam: Generalised Additive Models in greta using mgcv",
"description": "A module for greta (Golding (2019) <doi:10.21105/joss.01601>) that lets you use the 'mgcv' smoother functions and formula syntax to define smooth terms for use in a greta model. You can then define your own likelihood to complete the model, and fit it by MCMC. ",
"name": "greta.gam: Generalised Additive Models in 'greta' using 'mgcv'",
"relatedLink": "https://greta-dev.github.io/greta.gam/",
"codeRepository": "https://github.com/greta-dev/greta.gam",
"issueTracker": "https://github.com/greta-dev/greta.gam/issues",
"license": "https://spdx.org/licenses/GPL-2.0",
"license": "Apache License 2",
"version": "0.1.0",
"programmingLanguage": {
"@type": "ComputerLanguage",
Expand Down Expand Up @@ -37,15 +37,61 @@
"email": "[email protected]"
}
],
"copyrightHolder": [
{
"@type": "Person",
"givenName": "Nick",
"familyName": "Golding",
"email": "[email protected]",
"@id": "https://orcid.org/0000-0001-8916-5570"
}
],
"maintainer": [
{
"@type": "Person",
"givenName": "David L",
"familyName": "Miller",
"email": "[email protected]"
"givenName": "Nicholas",
"familyName": "Tierney",
"email": "[email protected]",
"@id": "https://orcid.org/0000-0003-1460-8722"
}
],
"softwareSuggestions": [
{
"@type": "SoftwareApplication",
"identifier": "knitr",
"name": "knitr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=knitr"
},
{
"@type": "SoftwareApplication",
"identifier": "rmarkdown",
"name": "rmarkdown",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=rmarkdown"
},
{
"@type": "SoftwareApplication",
"identifier": "spelling",
"name": "spelling",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=spelling"
},
{
"@type": "SoftwareApplication",
"identifier": "testthat",
Expand Down Expand Up @@ -123,7 +169,8 @@
},
"SystemRequirements": null
},
"fileSize": "85.96KB",
"fileSize": "208.45KB",
"releaseNotes": "https://github.com/greta-dev/greta.gam/blob/master/NEWS.md",
"readme": "https://github.com/greta-dev/greta.gam/blob/main/README.md",
"contIntegration": ["https://github.com/greta-dev/greta.gam/actions/workflows/R-CMD-check.yaml", "https://app.codecov.io/gh/greta-dev/greta.gam?branch=main"]
}
8 changes: 8 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
## Test environments

* local R installation, R 4.4.2
* win-builder (devel)

## R CMD check results

0 errors | 0 warnings | 1 note


## Submission notes

* This is a new release.
24 changes: 24 additions & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
CMD
Codecov
DL
Generalised
Marra
ORCID
arXiv
datatypes
doi
eigen
gam
generalised
greta
grey
jagam
joss
mgcv
mgcv's
modelling
naïve
nullspace
optimisation
penalise
’s
2 changes: 1 addition & 1 deletion man/evaluate_smooths.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/jagam2greta.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/smooths.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions tests/spelling.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
if(requireNamespace('spelling', quietly = TRUE))
spelling::spell_check_test(vignettes = TRUE, error = FALSE,
skip_on_cran = TRUE)

0 comments on commit b3d9165

Please sign in to comment.