diff --git a/.gitignore b/.gitignore index 5b6a065..1141bfd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +.DS_Store .Rproj.user .Rhistory .RData diff --git a/DESCRIPTION b/DESCRIPTION index ef330a6..91d0f4a 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,9 +1,9 @@ Package: biocompute Type: Package Title: Create and Manipulate BioCompute Objects -Version: 1.0.5 +Version: 1.0.6 Authors@R: c( - person("Jeffrey", "Grover", email = "jeffrey.grover@sevenbridges.com", role = c("aut", "cre")), + person("Jeffrey", "Grover", email = "jeffrey.grover@sevenbridges.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-6246-1767")), person("Soner", "Koc", email = "soner.koc@sevenbridges.com", role = c("aut"), comment = c(ORCID = "0000-0002-0772-6600")), person("Nan", "Xiao", role = c("aut"), comment = c(ORCID = "0000-0002-0250-5673")), person("Dennis", "Dean", email = "dennis.dean@sevenbridges.com", role = c("aut"), diff --git a/NEWS.md b/NEWS.md index 7086353..954d78c 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,9 @@ +# biocompute 1.0.6 + +## Improvements + +- Fixed broken links to BCO specification in documentation + # biocompute 1.0.5 ## Improvements diff --git a/R/compose-error.R b/R/compose-error.R index 1acdf9d..59c5e0d 100644 --- a/R/compose-error.R +++ b/R/compose-error.R @@ -3,7 +3,7 @@ #' The error domain can be used to determine what range of input #' returns outputs that are within the tolerance level defined #' in this subdomain and therefore can be used to optimize algorithm -#' (\href{https://github.com/biocompute-objects/BCO_Specification/blob/main/docs/error-domain.md}{domain definition}). +#' (\href{https://github.com/biocompute-objects/BCO_Specification/blob/1.3.0/error-domain.md}{domain definition}). #' #' @param empirical Data frame. Variables include \code{key} and \code{value}. #' Each row is one item in the empirical error subdomain. diff --git a/R/compose-parametric.R b/R/compose-parametric.R index ba96036..8ebc2ba 100644 --- a/R/compose-parametric.R +++ b/R/compose-parametric.R @@ -2,7 +2,7 @@ #' #' Non-default parameters customizing the computational flow #' which can affect the output of the calculations -#' (\href{https://github.com/biocompute-objects/BCO_Specification/blob/main/docs/parametric-domain.md}{domain definition}). +#' (\href{https://github.com/biocompute-objects/BCO_Specification/blob/1.3.0/parametric-domain.md}{domain definition}). #' #' @param df Data frame. Variables include \code{param} (parameter names), #' \code{value} (value of the parameters), and \code{step} diff --git a/R/compose-top-level-fields.R b/R/compose-top-level-fields.R index 0d937dc..bdda8dc 100644 --- a/R/compose-top-level-fields.R +++ b/R/compose-top-level-fields.R @@ -9,7 +9,7 @@ #' @param io I/O domain #' @param error Error domain #' @param bco_id BioCompute Object identifier -#' (\href{https://github.com/biocompute-objects/BCO_Specification/blob/main/docs/top-level.md#202-biocompute-object-identifier-object_id}{definition}). +#' (\href{https://github.com/biocompute-objects/BCO_Specification/blob/1.3.0/top-level.md#202-biocompute-object-identifier-bco_id}{definition}). #' If \code{NULL}, will use a UUID generated by \code{\link{generate_id}}. #' #' @return A vector of top level fields diff --git a/R/compose-usability.R b/R/compose-usability.R index 5a729f5..3313370 100644 --- a/R/compose-usability.R +++ b/R/compose-usability.R @@ -1,7 +1,7 @@ #' Compose BioCompute Object - Usability Domain (v1.3.0) #' #' The usability domain -#' (\href{https://github.com/biocompute-objects/BCO_Specification/blob/main/docs/usability-domain.md}{domain definition}). +#' (\href{https://github.com/biocompute-objects/BCO_Specification/blob/1.3.0/usability-domain.md}{domain definition}). #' #' @param text A character vector of free text values that could #' improves search-ability, provide specific scientific use cases, diff --git a/R/validate-checksum.R b/R/validate-checksum.R index ae2411d..dcc904f 100644 --- a/R/validate-checksum.R +++ b/R/validate-checksum.R @@ -10,7 +10,7 @@ #' @export validate_checksum_v1.3.0 #' #' @note An SHA-256 checksum is -#' \href{https://github.com/biocompute-objects/BCO_Specification/blob/main/docs/top-level.md#203-etag-etag}{calculated and stored} +#' \href{https://github.com/biocompute-objects/BCO_Specification/blob/1.3.0/top-level.md#203-checksum-checksum}{calculated and stored} #' in the top level fields when a BioCompute Object is created. In reality, #' due to the delicate differences in how the data in JSON is represented, #' parsed, and handled in different languages, there could be false positives diff --git a/README.md b/README.md index 3dac31b..812cd3e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # biocompute -[![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing) +[![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing) [![CRAN Version](https://www.r-pkg.org/badges/version/biocompute)](https://cran.r-project.org/package=biocompute) [![Travis build status](https://travis-ci.org/sbg/biocompute.svg?branch=master)](https://travis-ci.org/sbg/biocompute) [![Downloads from the RStudio CRAN mirror](https://cranlogs.r-pkg.org/badges/grand-total/biocompute)](https://cran.r-project.org/package=biocompute) diff --git a/biocompute.Rproj b/biocompute.Rproj index 270314b..be6e327 100644 --- a/biocompute.Rproj +++ b/biocompute.Rproj @@ -18,4 +18,5 @@ StripTrailingWhitespace: Yes BuildType: Package PackageUseDevtools: Yes PackageInstallArgs: --no-multiarch --with-keep.source +PackageCheckArgs: --as-cran PackageRoxygenize: rd,collate,namespace diff --git a/cran-comments.md b/cran-comments.md index 28ede07..b5079d6 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,3 +1,14 @@ +# biocompute 1.0.6 + +## Test environments + +- Local macOS install, R 4.1.1 +- Ubuntu 20.04.1 LTS (on R-hub), R 4.1.1 +- win-builder (release, devel, and oldrelease) + +## R CMD check results + +There were no ERRORs or WARNINGs. # biocompute 1.0.3 ## Test environments diff --git a/docs/404.html b/docs/404.html index 213432e..64ca36d 100644 --- a/docs/404.html +++ b/docs/404.html @@ -73,7 +73,7 @@ biocompute - 1.0.5 + 1.0.6 @@ -81,7 +81,7 @@
vignettes/case-study.Rmd
case-study.Rmd
["https://w3id.org/biocompute/1.3.0/", "https://biocompute.sbgenomics.com/bco/c69950d2-1810-460c-9a52-79ec1611178e", "bb8d01d21cd9e78661130ef73e7047a952e13decbb5f642b848086e1f6afc54d"]
+["https://w3id.org/biocompute/1.3.0/", "https://biocompute.sbgenomics.com/bco/9ae6e120-4182-48f8-9071-d4f688632a1b", "6323142e7d0888d5f73ec22efeced416f9ead8293e9095800df4559cf8f836d7"]
{
"bco_spec_version": "https://w3id.org/biocompute/1.3.0/",
- "bco_id": "https://biocompute.sbgenomics.com/bco/c69950d2-1810-460c-9a52-79ec1611178e",
- "checksum": "bb8d01d21cd9e78661130ef73e7047a952e13decbb5f642b848086e1f6afc54d",
+ "bco_id": "https://biocompute.sbgenomics.com/bco/9ae6e120-4182-48f8-9071-d4f688632a1b",
+ "checksum": "6323142e7d0888d5f73ec22efeced416f9ead8293e9095800df4559cf8f836d7",
"provenance_domain": {
"name": "HCV1a ledipasvir resistance SNP detection",
"version": "1.0.0",
@@ -834,7 +834,7 @@
],
"derived_from": "https://github.com/biocompute-objects/BCO_Specification/blob/1.2.1-beta/HCV1a.json",
"obsolete_after": "2018-11-12T12:30:48-0500",
- "embargo": ["2017-10-12T20:30:48+0300", "2017-11-12T20:30:48+0300"],
+ "embargo": ["2017-10-12T12:30:48-0500", "2017-11-12T12:30:48-0500"],
"created": "2017-01-20T09:40:17-0500",
"modified": "2019-05-10T09:40:17-0500",
"contributors": [
@@ -908,25 +908,25 @@
"namespace": "pubchem.compound",
"name": "PubChem-compound",
"ids": "67505836",
- "access_time": "2017-01-20T17:40:17+0300"
+ "access_time": "2017-01-20T09:40:17-0500"
},
{
"namespace": "pubmed",
"name": "PubMed",
"ids": "26508693",
- "access_time": "2017-01-21T17:40:17+0300"
+ "access_time": "2017-01-21T09:40:17-0500"
},
{
"namespace": "so",
"name": "Sequence Ontology",
"ids": ["SO:000002", "SO:0000694", "SO:0000667", "SO:0000045"],
- "access_time": "2017-01-22T17:40:17+0300"
+ "access_time": "2017-01-22T09:40:17-0500"
},
{
"namespace": "taxonomy",
"name": "Taxonomy",
"ids": "31646",
- "access_time": "2017-01-23T17:40:17+0300"
+ "access_time": "2017-01-23T09:40:17-0500"
}
],
"platform": "Seven Bridges Platform",
@@ -941,56 +941,56 @@
"name": "Hepatitis C virus genotype 1",
"uri": {
"uri": "https://www.ncbi.nlm.nih.gov/nuccore/22129792",
- "access_time": "2017-01-24 17:40:17"
+ "access_time": "2017-01-24 09:40:17"
}
},
{
"name": "Hepatitis C virus type 1b complete genome",
"uri": {
"uri": "https://www.ncbi.nlm.nih.gov/nuccore/5420376",
- "access_time": "2017-01-24 17:40:17"
+ "access_time": "2017-01-24 09:40:17"
}
},
{
"name": "Hepatitis C virus (isolate JFH-1) genomic RNA",
"uri": {
"uri": "https://www.ncbi.nlm.nih.gov/nuccore/13122261",
- "access_time": "2017-01-24 17:40:17"
+ "access_time": "2017-01-24 09:40:17"
}
},
{
"name": "Hepatitis C virus clone J8CF, complete genome",
"uri": {
"uri": "https://www.ncbi.nlm.nih.gov/nuccore/386646758",
- "access_time": "2017-01-24 17:40:17"
+ "access_time": "2017-01-24 09:40:17"
}
},
{
"name": "Hepatitis C virus S52 polyprotein gene",
"uri": {
"uri": "https://www.ncbi.nlm.nih.gov/nuccore/295311559",
- "access_time": "2017-01-24 17:40:17"
+ "access_time": "2017-01-24 09:40:17"
}
}
],
"input_list": [
{
"uri": "https://example.com/dna.cgi?cmd=objFile&ids=514683",
- "access_time": "2017-01-24 17:40:17"
+ "access_time": "2017-01-24 09:40:17"
},
{
"uri": "https://example.com/dna.cgi?cmd=objFile&ids=514682",
- "access_time": "2017-01-24 17:40:17"
+ "access_time": "2017-01-24 09:40:17"
}
],
"output_list": [
{
"uri": "https://example.com/data/514769/allCount-aligned.csv",
- "access_time": "2017-01-24 17:40:17"
+ "access_time": "2017-01-24 09:40:17"
},
{
"uri": "https://example.com/data/514801/SNPProfile*.csv",
- "access_time": "2017-01-24 17:40:17"
+ "access_time": "2017-01-24 09:40:17"
}
]
}
@@ -1006,7 +1006,7 @@
"uri": [
{
"uri": "https://example.com/dna.cgi?cmd=dna-hexagon&cmdMode=-",
- "access_time": "2017-01-24 17:40:17",
+ "access_time": "2017-01-24 09:40:17",
"sha1_chksum": "d60f506cddac09e9e816531e7905ca1ca6641e3c"
}
]
@@ -1017,7 +1017,7 @@
"uri": [
{
"uri": "https://example.com/dna.cgi?cmd=dna-heptagon&cmdMode=-",
- "access_time": "2017-01-24 17:40:17",
+ "access_time": "2017-01-24 09:40:17",
"sha1_chksum": "NA"
}
]
@@ -1082,7 +1082,7 @@
{
"filename": "Hepatitis C virus genotype 1",
"uri": "https://www.ncbi.nlm.nih.gov/nuccore/22129792",
- "access_time": "2017-01-24T17:40:17+0300"
+ "access_time": "2017-01-24T09:40:17-0500"
}
]
},
@@ -1091,7 +1091,7 @@
{
"filename": "Hepatitis C virus type 1b complete genome",
"uri": "https://www.ncbi.nlm.nih.gov/nuccore/5420376",
- "access_time": "2017-01-24T17:40:17+0300"
+ "access_time": "2017-01-24T09:40:17-0500"
}
]
}
@@ -1102,7 +1102,7 @@
"uri": [
{
"uri": "https://example.com/data/514769/dnaAccessionBased.csv",
- "access_time": "2017-01-24T17:40:17+0300"
+ "access_time": "2017-01-24T09:40:17-0500"
}
]
},
@@ -1111,7 +1111,7 @@
"uri": [
{
"uri": "https://example.com/data/514801/SNPProfile*.csv",
- "access_time": "2017-01-24T17:40:17+0300"
+ "access_time": "2017-01-24T09:40:17-0500"
}
]
}
diff --git a/docs/articles/case-study_files/header-attrs-2.10/header-attrs.js b/docs/articles/case-study_files/header-attrs-2.10/header-attrs.js
new file mode 100644
index 0000000..dd57d92
--- /dev/null
+++ b/docs/articles/case-study_files/header-attrs-2.10/header-attrs.js
@@ -0,0 +1,12 @@
+// Pandoc 2.9 adds attributes on both header and div. We remove the former (to
+// be compatible with the behavior of Pandoc < 2.8).
+document.addEventListener('DOMContentLoaded', function(e) {
+ var hs = document.querySelectorAll("div.section[class*='level'] > :first-child");
+ var i, h, a;
+ for (i = 0; i < hs.length; i++) {
+ h = hs[i];
+ if (!/^h[1-6]$/i.test(h.tagName)) continue; // it should be a header h1-h6
+ a = h.attributes;
+ while (a.length > 0) h.removeAttribute(a[0].name);
+ }
+});
diff --git a/docs/articles/index.html b/docs/articles/index.html
index 4b874fe..2010d99 100644
--- a/docs/articles/index.html
+++ b/docs/articles/index.html
@@ -73,7 +73,7 @@
biocompute
- 1.0.5
+ 1.0.6
vignettes/intro.Rmd
intro.Rmd
{
"bco_spec_version": "https://w3id.org/biocompute/1.3.0/",
- "bco_id": "https://biocompute.sbgenomics.com/bco/c8d60fd4-71d8-46db-b9d5-fc8b287dba35",
+ "bco_id": "https://biocompute.sbgenomics.com/bco/71ed7801-7391-4120-9570-560a68d2e3e8",
"checksum": "d743d2f1407707eadcc2a700f7c506f13deddf6bf9c8d9d888e9087cc67a1c8f",
"provenance_domain": {
"name": [],
@@ -304,10 +304,10 @@
convert_json() %>%
export_json(bco)
bco %>% validate_checksum()
── Loading BioCompute Object ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
-── Validating Checksum ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
-Documented checksum: bb8d01d21cd9e78661130ef73e7047a952e13decbb5f642b848086e1f6afc54d
-Calculated checksum: bb8d01d21cd9e78661130ef73e7047a952e13decbb5f642b848086e1f6afc54d
+── Loading BioCompute Object ───────────────────────────────────────────────────
+── Validating Checksum ─────────────────────────────────────────────────────────
+Documented checksum: 6323142e7d0888d5f73ec22efeced416f9ead8293e9095800df4559cf8f836d7
+Calculated checksum: 6323142e7d0888d5f73ec22efeced416f9ead8293e9095800df4559cf8f836d7
Documented and calculated checksum matched.
bco <- tempfile(fileext = ".json")
@@ -315,13 +315,13 @@
convert_json() %>%
export_json(bco)
bco %>% validate_schema()
-── 0: Validating BioCompute Object ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
+── 0: Validating BioCompute Object ─────────────────────────────────────────────
[1] FALSE
attr(,"errors")
field message
1 data.extension_domain.fhir_extension is the wrong type
-── 1: Validating Provenance Domain ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
+── 1: Validating Provenance Domain ─────────────────────────────────────────────
[1] FALSE
attr(,"errors")
field message
@@ -332,10 +332,10 @@
5 data.created must be date-time format
6 data.modified must be date-time format
-── 2: Validating Usability Domain ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
+── 2: Validating Usability Domain ──────────────────────────────────────────────
[1] TRUE
-── 3.1: Validating Extension Domain (FHIR Extension) ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
+── 3.1: Validating Extension Domain (FHIR Extension) ───────────────────────────
[1] FALSE
attr(,"errors")
field message
@@ -345,10 +345,10 @@
4 data.fhir_resources.3 is the wrong type
5 data.fhir_resources.4 is the wrong type
-── 3.2: Validating Extension Domain (SCM Extension) ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
+── 3.2: Validating Extension Domain (SCM Extension) ────────────────────────────
[1] TRUE
-── 4: Validating Description Domain ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
+── 4: Validating Description Domain ────────────────────────────────────────────
[1] FALSE
attr(,"errors")
field message
@@ -362,7 +362,7 @@
8 data.platform is the wrong type
9 data.pipeline_steps.0.step_number is the wrong type
-── 5: Validating Execution Domain ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
+── 5: Validating Execution Domain ──────────────────────────────────────────────
[1] FALSE
attr(,"errors")
field message
@@ -371,13 +371,13 @@
3 data.external_data_endpoints.1 is the wrong type
4 data.external_data_endpoints.2 is the wrong type
-── 6: Validating Parametric Domain ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
+── 6: Validating Parametric Domain ─────────────────────────────────────────────
[1] TRUE
-── 7: Validating I/O Domain ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
+── 7: Validating I/O Domain ────────────────────────────────────────────────────
[1] TRUE
-── 8: Validating Error Domain ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
+── 8: Validating Error Domain ──────────────────────────────────────────────────
[1] TRUE
Jeffrey Grover. Author, maintainer. +
\value
RD tag to exported functions to explain the return results.Maintainer: Jeffrey Grover jeffrey.grover@sevenbridges.com
+Maintainer: Jeffrey Grover jeffrey.grover@sevenbridges.com (ORCID)
Authors:
Soner Koc soner.koc@sevenbridges.com (ORCID)
Nan Xiao (ORCID)
The error domain can be used to determine what range of input returns outputs that are within the tolerance level defined in this subdomain and therefore can be used to optimize algorithm -(domain definition).
+(domain definition).compose_error_v1.3.0(empirical = NULL, algorithmic = NULL) diff --git a/docs/reference/compose_execution.html b/docs/reference/compose_execution.html index 434f0ad..5e83170 100644 --- a/docs/reference/compose_execution.html +++ b/docs/reference/compose_execution.html @@ -74,7 +74,7 @@ biocompute - 1.0.5 + 1.0.6
Non-default parameters customizing the computational flow which can affect the output of the calculations -(domain definition).
+(domain definition).compose_parametric_v1.3.0(df = NULL) diff --git a/docs/reference/compose_provenance.html b/docs/reference/compose_provenance.html index dbc033a..9869a98 100644 --- a/docs/reference/compose_provenance.html +++ b/docs/reference/compose_provenance.html @@ -74,7 +74,7 @@ biocompute - 1.0.5 + 1.0.6 @@ -82,7 +82,7 @@
BioCompute Object identifier
-(definition).
+(definition).
If NULL
, will use a UUID generated by generate_id
.
The usability domain -(domain definition).
+(domain definition).compose_usability_v1.3.0(text = NULL) diff --git a/docs/reference/convert_json.html b/docs/reference/convert_json.html index c2fbb5e..95188f3 100644 --- a/docs/reference/convert_json.html +++ b/docs/reference/convert_json.html @@ -74,7 +74,7 @@ biocompute - 1.0.5 + 1.0.6 @@ -82,7 +82,7 @@
Additional parameters for render
.
Additional parameters for render
.
Additional parameters for render
.
Additional parameters for render
.
Additional parameters for render
.
Additional parameters for render
.
+generate_id() -#> [1] "https://biocompute.sbgenomics.com/bco/2aac8ff7-5b43-4ef6-a3a5-bb35f492c398"
An SHA-256 checksum is -calculated and stored +calculated and stored in the top level fields when a BioCompute Object is created. In reality, due to the delicate differences in how the data in JSON is represented, parsed, and handled in different languages, there could be false positives @@ -168,11 +168,11 @@