diff --git a/404.html b/404.html index 19f72e89..5931f00b 100644 --- a/404.html +++ b/404.html @@ -6,7 +6,7 @@ Page not found (404) • rDataPipeline - + @@ -18,7 +18,7 @@ - +
- +
@@ -88,16 +88,16 @@

Page not found (404)

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/LICENSE.html b/LICENSE.html index 5184cf92..8be672e6 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -1,9 +1,9 @@ -GNU General Public License • rDataPipelineGNU General Public License • rDataPipeline - +
- +
@@ -216,27 +216,27 @@

17. Interpretation of Sectio

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.

-
<one line to give the program's name and a brief idea of what it does.>
-Copyright (C) <year>  <name of author>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
<one line to give the program's name and a brief idea of what it does.>
+Copyright (C) <year>  <name of author>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:

-
<program>  Copyright (C) <year>  <name of author>
-This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'.
-This is free software, and you are welcome to redistribute it
-under certain conditions; type 'show c' for details.
+
<program>  Copyright (C) <year>  <name of author>
+This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'.
+This is free software, and you are welcome to redistribute it
+under certain conditions; type 'show c' for details.

The hypothetical commands show w and show c should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”.

You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <http://www.gnu.org/licenses/>.

The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.

@@ -258,15 +258,15 @@

How to Apply These Terms

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/authors.html b/authors.html index 3f070f08..1998455b 100644 --- a/authors.html +++ b/authors.html @@ -1,9 +1,9 @@ -Authors and Citation • rDataPipelineAuthors and Citation • rDataPipeline - +
- +
-

Authors

+

Authors and Citation

- +

  • Sonia Mitchell. Maintainer, author.

    @@ -60,20 +60,21 @@

    Authors

    Citation

    - Source: DESCRIPTION + Source: DESCRIPTION
    -

    Mitchell S (2023). +

    Mitchell S (2024). rDataPipeline: Functions to Interact with the 'FAIR Data Pipeline'. -https://www.fairdatapipeline.org/rDataPipeline/, https://github.com/FAIRDataPipeline/rDataPipeline. +R package version 0.54.3, https://github.com/FAIRDataPipeline/rDataPipeline, https://www.fairdatapipeline.org/rDataPipeline/. 

    @Manual{,
   title = {rDataPipeline: Functions to Interact with the 'FAIR Data Pipeline'},
   author = {Sonia Mitchell},
-  year = {2023},
-  note = {https://www.fairdatapipeline.org/rDataPipeline/, https://github.com/FAIRDataPipeline/rDataPipeline},
+  year = {2024},
+  note = {R package version 0.54.3, https://github.com/FAIRDataPipeline/rDataPipeline},
+  url = {https://www.fairdatapipeline.org/rDataPipeline/},
 }
@@ -87,15 +88,15 @@

Citation

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/index.html b/index.html index 76733b73..87e2bbb1 100644 --- a/index.html +++ b/index.html @@ -6,22 +6,20 @@ Functions to Interact with the FAIR Data Pipeline • rDataPipeline - + - + - +
- +
@@ -78,9 +76,7 @@

rDataPipelineInstallation

In R:

-
install.packages(devtools)
-devtools::install_github("FAIRDataPipeline/rDataPipeline")
-library(rDataPipeline)
+

{r} install.packages(devtools) devtools::install_github("FAIRDataPipeline/rDataPipeline") library(rDataPipeline)

Usage @@ -142,16 +138,16 @@

Developers

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/news/index.html b/news/index.html index 0cb8e09d..8a855c0f 100644 --- a/news/index.html +++ b/news/index.html @@ -1,9 +1,9 @@ -Changelog • rDataPipelineChangelog • rDataPipeline - +
- +

Changelog

- Source: NEWS.md + Source: NEWS.md
@@ -61,15 +61,15 @@

Changelog

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/pkgdown.yml b/pkgdown.yml index 085fa873..171130f0 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,9 +1,8 @@ -pandoc: 2.19.2 -pkgdown: 2.0.7 +pandoc: 3.1.11 +pkgdown: 2.1.0 pkgdown_sha: ~ articles: {} -last_built: 2023-07-13T07:22Z +last_built: 2024-09-05T15:31Z urls: reference: https://www.fairdatapipeline.org/rDataPipeline/reference article: https://www.fairdatapipeline.org/rDataPipeline/articles - diff --git a/reference/add_read.html b/reference/add_read.html index 8d0ae88c..d3b08f9e 100644 --- a/reference/add_read.html +++ b/reference/add_read.html @@ -1,10 +1,10 @@ -add_read — add_read • rDataPipelineadd_read — add_read • rDataPipeline - +
- +

add_read

- Source: R/add_read.R + Source: R/add_read.R
@@ -69,42 +69,44 @@

add_read

Arguments

-
path
+ + +
path

config file path

-
data_product
+
data_product

data_product field

-
component
+
component

component field

-
version
+
version

(optional) version field

-
use_data_product
+
use_data_product

(optional) use_data_product field

-
use_component
+
use_component

(optional) use_component field

-
use_version
+
use_version

(optional) use_version field

-
use_namespace
+
use_namespace

(optional) use_namespace field

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 path <- "test_config/config.yaml"
 
 # Write run_metadata block
@@ -118,7 +120,7 @@ 
Examples

          data_product = "test/array",
          component = "level/a/s/d/f/s",
          version = "0.2.0")
-}
+} # }
@@ -134,15 +136,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/add_write.html b/reference/add_write.html index ac78c6c2..b4ead1d2 100644 --- a/reference/add_write.html +++ b/reference/add_write.html @@ -1,10 +1,10 @@ -add_write — add_write • rDataPipelineadd_write — add_write • rDataPipeline - +
- +

add_write

- Source: R/add_write.R + Source: R/add_write.R
@@ -70,46 +70,48 @@

add_write

Arguments

-
path
+ + +
path

config file path

-
data_product
+
data_product

data_product field

-
description
+
description

component field

-
version
+
version

(optional) version field

-
file_type
+
file_type

(optional) file type field

-
use_data_product
+
use_data_product

(optional) use_data_product field

-
use_component
+
use_component

(optional) use_component field

-
use_version
+
use_version

(optional) use_version field

-
use_namespace
+
use_namespace

(optional) use_namespace field

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 path <- "test_config/config.yaml"
 
 # Write run_metadata block
@@ -123,7 +125,7 @@ 
Examples

           data_product = "test/array",
           description = "data product description",
           version = "0.2.0")
-}
+} # }
@@ -139,15 +141,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/check_config.html b/reference/check_config.html index ad30cd98..37f65172 100644 --- a/reference/check_config.html +++ b/reference/check_config.html @@ -1,9 +1,9 @@ -check_config — check_config • rDataPipelinecheck_config — check_config • rDataPipeline - +
- +

check_config

- Source: R/check_config.R + Source: R/check_config.R
@@ -58,16 +58,18 @@

check_config

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

data_product

-
what
+
what

what

@@ -84,15 +86,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/check_dataproduct_exists.html b/reference/check_dataproduct_exists.html index 13bd36ed..139002e6 100644 --- a/reference/check_dataproduct_exists.html +++ b/reference/check_dataproduct_exists.html @@ -1,10 +1,10 @@ -check_dataproduct_exists — check_dataproduct_exists • rDataPipelinecheck_dataproduct_exists — check_dataproduct_exists • rDataPipeline - +
- +

check_dataproduct_exists

- Source: R/check_dataproduct_exists.R + Source: R/check_dataproduct_exists.R
@@ -65,19 +65,21 @@

check_dataproduct_exists

Arguments

-
write_dataproduct
+ + +
write_dataproduct

write_dataproduct

-
write_version
+
write_version

write_version

-
write_namespace_id
+
write_namespace_id

write_namespace_id

-
endpoint
+
endpoint

endpoint

@@ -94,15 +96,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/check_datetime.html b/reference/check_datetime.html index b5e71ba8..6aae3c37 100644 --- a/reference/check_datetime.html +++ b/reference/check_datetime.html @@ -1,9 +1,9 @@ -check_datetime — check_datetime • rDataPipelinecheck_datetime — check_datetime • rDataPipeline - +
- +

check_datetime

- Source: R/check_datetime.R + Source: R/check_datetime.R
@@ -58,19 +58,21 @@

check_datetime

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
this_field
+
this_field

a string specifying the name of the field

-
query_class
+
query_class

a string specifying the class of the field

-
this_query
+
this_query

a string specifying the contents of the field

@@ -87,15 +89,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/check_exists.html b/reference/check_exists.html index d5931725..01397fb2 100644 --- a/reference/check_exists.html +++ b/reference/check_exists.html @@ -1,9 +1,9 @@ -Check if entry exists in the data registry — check_exists • rDataPipelineCheck if entry exists in the data registry — check_exists • rDataPipeline - +
- +

Check if entry exists in the data registry

- Source: R/check_exists.R + Source: R/check_exists.R
@@ -58,20 +58,20 @@

Check if entry exists in the data registry

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
query
+
query

a list containing a valid query for the table, e.g. list(field = value)

Value

- - -

Returns TRUE if the entry exists and FALSE if it +

Returns TRUE if the entry exists and FALSE if it doesn't

@@ -87,15 +87,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/check_field.html b/reference/check_field.html index b6aed414..a401bf64 100644 --- a/reference/check_field.html +++ b/reference/check_field.html @@ -1,9 +1,9 @@ -check_field — check_field • rDataPipelinecheck_field — check_field • rDataPipeline - +
- +

check_field

- Source: R/check_field.R + Source: R/check_field.R
@@ -58,27 +58,29 @@

check_field

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
this_field
+
this_field

a string specifying the name of the field

-
query_class
+
query_class

a string specifying the class of the field

-
this_query
+
this_query

a string specifying the contents of the field

-
method
+
method

a string specifying the method, c("GET", "POST")

-
endpoint
+
endpoint

endpoint

@@ -95,15 +97,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/check_fields.html b/reference/check_fields.html index 276e3514..dccf9e11 100644 --- a/reference/check_fields.html +++ b/reference/check_fields.html @@ -1,9 +1,9 @@ -check_fields — check_fields • rDataPipelinecheck_fields — check_fields • rDataPipeline - +
- +

check_fields

- Source: R/check_fields.R + Source: R/check_fields.R
@@ -58,19 +58,21 @@

check_fields

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
query
+
query

a list containing the query

-
method
+
method

a string specifying the method, c("GET", "POST")

-
endpoint
+
endpoint

endpoint

@@ -87,15 +89,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/check_handle.html b/reference/check_handle.html index b0c3ea17..e36c1b3c 100644 --- a/reference/check_handle.html +++ b/reference/check_handle.html @@ -1,9 +1,9 @@ -check_handle — check_handle • rDataPipelinecheck_handle — check_handle • rDataPipeline - +
- +

check_handle

- Source: R/check_handle.R + Source: R/check_handle.R
@@ -58,20 +58,22 @@

check_handle

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying the name of the data product

-
what
-

element in handle -- one of c("inputs", "outputs")

+
what
+

element in handle – one of c("inputs", "outputs")

-
component
+
component

a string specifying the name of the component

@@ -88,15 +90,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/check_integer.html b/reference/check_integer.html index 98f09bad..39951e8d 100644 --- a/reference/check_integer.html +++ b/reference/check_integer.html @@ -1,9 +1,9 @@ -check_integer — check_integer • rDataPipelinecheck_integer — check_integer • rDataPipeline - +
- +

check_integer

- Source: R/check_integer.R + Source: R/check_integer.R
@@ -58,19 +58,21 @@

check_integer

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
this_field
+
this_field

a string specifying the name of the field

-
query_class
+
query_class

a string specifying the class of the field

-
this_query
+
this_query

a string specifying the contents of the field

@@ -87,15 +89,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/check_local_repo.html b/reference/check_local_repo.html index 18705d24..093c018d 100644 --- a/reference/check_local_repo.html +++ b/reference/check_local_repo.html @@ -1,9 +1,9 @@ -check_local_repo — check_local_repo • rDataPipelinecheck_local_repo — check_local_repo • rDataPipeline - +
- +

check_local_repo

- Source: R/check_local_repo.R + Source: R/check_local_repo.R
@@ -58,15 +58,15 @@

check_local_repo

Arguments

-
path
+ + +
path

Local repository file path

Value

- - -

boolean, if local repository is clean (TRUE, else FALSE)

+

boolean, if local repository is clean (TRUE, else FALSE)

@@ -81,15 +81,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/check_string.html b/reference/check_string.html index 81746445..c9d84124 100644 --- a/reference/check_string.html +++ b/reference/check_string.html @@ -1,9 +1,9 @@ -check_string — check_string • rDataPipelinecheck_string — check_string • rDataPipeline - +
- +

check_string

- Source: R/check_string.R + Source: R/check_string.R
@@ -58,15 +58,17 @@

check_string

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
this_field
+
this_field

a string specifying the name of the field

-
this_query
+
this_query

a string specifying the contents of the field

@@ -83,15 +85,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/check_table_exists.html b/reference/check_table_exists.html index 303ffd65..e1ca1862 100644 --- a/reference/check_table_exists.html +++ b/reference/check_table_exists.html @@ -1,9 +1,9 @@ -Check if table exists — check_table_exists • rDataPipelineCheck if table exists — check_table_exists • rDataPipeline - +
- +

Check if table exists

- Source: R/check_table_exists.R + Source: R/check_table_exists.R
@@ -58,15 +58,15 @@

Check if table exists

Arguments

-
table
+ + +
table

a string specifying the name of the table

Value

- - -

Returns TRUE if a table exists, FALSE if it doesn't

+

Returns TRUE if a table exists, FALSE if it doesn't

@@ -81,15 +81,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/check_yaml_write.html b/reference/check_yaml_write.html index 20b7cee1..e5284809 100644 --- a/reference/check_yaml_write.html +++ b/reference/check_yaml_write.html @@ -1,9 +1,9 @@ -check_yaml_write — check_yaml_write • rDataPipelinecheck_yaml_write — check_yaml_write • rDataPipeline - +
- +

check_yaml_write

- Source: R/check_yaml_write.R + Source: R/check_yaml_write.R
@@ -58,11 +58,13 @@

check_yaml_write

Arguments

-
handle
+ + +
handle

fdp object

-
data_product
+
data_product

a string specifying the name of the data product

@@ -79,15 +81,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/clean_query.html b/reference/clean_query.html index 259eb4a3..b330fa52 100644 --- a/reference/clean_query.html +++ b/reference/clean_query.html @@ -1,9 +1,9 @@ -Clean query — clean_query • rDataPipelineClean query — clean_query • rDataPipeline - +
- +

Clean query

- Source: R/clean_query.R + Source: R/clean_query.R
@@ -58,12 +58,14 @@

Clean query

Arguments

-
data
+ + +
data

a list containing a valid query for the table, e.g. list(field = value)

-
endpoint
+
endpoint

endpoint

@@ -80,15 +82,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/create_config.html b/reference/create_config.html index 96b8b802..18062656 100644 --- a/reference/create_config.html +++ b/reference/create_config.html @@ -1,11 +1,11 @@ -create_config — create_config • rDataPipelinecreate_config — create_config • rDataPipeline - +
- +

create_config

- Source: R/create_config.R + Source: R/create_config.R
@@ -70,31 +70,33 @@

create_config

Arguments

-
path
+ + +
path

config file path

-
description
+
description

description field

-
input_namespace
+
input_namespace

input_namespace field

-
output_namespace
+
output_namespace

output_namespace field

-
write_data_store
+
write_data_store

write_data_store field

-
force
+
force

force

-
local_repo
+
local_repo

local_repo

@@ -111,15 +113,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/create_index.html b/reference/create_index.html index 46321fde..612a7e15 100644 --- a/reference/create_index.html +++ b/reference/create_index.html @@ -1,9 +1,9 @@ -create_index — create_index • rDataPipelinecreate_index — create_index • rDataPipeline - +
- +

create_index

- Source: R/create_index.R + Source: R/create_index.R
@@ -58,7 +58,9 @@

create_index

Arguments

-
self
+ + +
self

self

@@ -75,15 +77,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/create_version_number.html b/reference/create_version_number.html index 79b4d269..ecb31752 100644 --- a/reference/create_version_number.html +++ b/reference/create_version_number.html @@ -1,5 +1,5 @@ -Create version number — create_version_number • rDataPipelineCreate version number — create_version_number • rDataPipeline - +
- +

Create version number

- Source: R/create_version_number.R + Source: R/create_version_number.R
@@ -74,7 +74,9 @@

Create version number

Arguments

-
download_date
+ + +
download_date

(Optional) download_date This can either be a date or datetime but must include the full year @@ -91,37 +93,29 @@

Arguments

e.g. 20200201

-
version
+
version

version number using major.minor.patch numbering e.g. 0.1.0 or major.patch e.g. 0.0

-
major
+
major

major number if not using version

-
minor
+
minor

minor number if not using date

-
patch
+
patch

patch number if not using version

Value

- - -

returns a character vector in the format of major.minor.patch

- - -

e.g.

-

-

0.20200101.0

- - +

returns a character vector in the format of major.minor.patch +e.g. 0.20200101.0

@@ -136,15 +130,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/download_from_database.html b/reference/download_from_database.html index ede6128c..de9616a9 100644 --- a/reference/download_from_database.html +++ b/reference/download_from_database.html @@ -1,9 +1,9 @@ -Download source file from database — download_from_database • rDataPipelineDownload source file from database — download_from_database • rDataPipeline - +
- +

Download source file from database

- Source: R/download_from_database.R + Source: R/download_from_database.R
@@ -64,31 +64,33 @@

Download source file from database

Arguments

-
source_root
+ + +
source_root

a string specifying the source root

-
source_path
+
source_path

a string specifying the source path

-
path
+
path

a string specifying where the file will be saved

-
filename
+
filename

a string specifying the filename (the name given to the saved file)

-
overwrite
+
overwrite

a boolean specifying whether or not the file should be overwritten if it already exists

See also

-

Other download functions: +

Other download functions: download_from_url()

@@ -104,15 +106,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/download_from_url.html b/reference/download_from_url.html index 5ba0af7c..c78b9b34 100644 --- a/reference/download_from_url.html +++ b/reference/download_from_url.html @@ -1,9 +1,9 @@ -Download source file from URL — download_from_url • rDataPipelineDownload source file from URL — download_from_url • rDataPipeline - +
- +

Download source file from URL

- Source: R/download_from_url.R + Source: R/download_from_url.R
@@ -58,26 +58,28 @@

Download source file from URL

Arguments

-
source_root
+ + +
source_root

a string specifying the source root

-
source_path
+
source_path

a string specifying the source path

-
path
+
path

a string specifying where the file will be saved

-
filename
+
filename

a string specifying the filename (the name given to the saved file)

See also

-

Other download functions: +

Other download functions: download_from_database()

@@ -93,15 +95,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/extract_id.html b/reference/extract_id.html index 38646e14..77affae8 100644 --- a/reference/extract_id.html +++ b/reference/extract_id.html @@ -1,9 +1,9 @@ -extract_id — extract_id • rDataPipelineextract_id — extract_id • rDataPipeline - +
- +

extract_id

- Source: R/extract_id.R + Source: R/extract_id.R
@@ -58,11 +58,13 @@

extract_id

Arguments

-
url
+ + +
url

url

-
endpoint
+
endpoint

endpoint

@@ -79,15 +81,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/fair_init.html b/reference/fair_init.html index 09325779..58a3e4a9 100644 --- a/reference/fair_init.html +++ b/reference/fair_init.html @@ -1,9 +1,9 @@ -fair_init — fair_init • rDataPipelinefair_init — fair_init • rDataPipeline - +
- +

fair_init

- Source: R/fair_init.R + Source: R/fair_init.R
@@ -58,18 +58,20 @@

fair_init

Arguments

-
name
+ + +
name

a string specifying the full name or organisation name of the author; note that at least one of name or identifier must be specified

-
identifier
+
identifier

(optional) a string specifying the full URL identifier (e.g. ORCiD or ROR ID) of the author

-
endpoint
+
endpoint

a string specifying the registry endpoint

@@ -86,15 +88,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/fair_run.html b/reference/fair_run.html index 1220b0d2..00354b6c 100644 --- a/reference/fair_run.html +++ b/reference/fair_run.html @@ -1,9 +1,9 @@ -fair_run — fair_run • rDataPipelinefair_run — fair_run • rDataPipeline - +
- +

fair_run

- Source: R/fair_run.R + Source: R/fair_run.R
@@ -62,15 +62,17 @@

fair_run

Arguments

-
path
+ + +
path

string

-
endpoint
+
endpoint

a string specifying the registry endpoint

-
skip
+
skip

don't bother checking whether the repo is clean

@@ -87,15 +89,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/fdp-class.html b/reference/fdp-class.html index 50162c89..c86d4b11 100644 --- a/reference/fdp-class.html +++ b/reference/fdp-class.html @@ -1,10 +1,10 @@ -fdp-class — fdp-class • rDataPipelinefdp-class — fdp-class • rDataPipeline - +
- +

fdp-class

- Source: R/class-fdp.R + Source: R/class-fdp.R
@@ -112,7 +112,7 @@

Public fields

Methods

- +

Public methods

@@ -563,15 +563,15 @@

Arguments -

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/fdp.html b/reference/fdp.html new file mode 100644 index 00000000..56e2f45f --- /dev/null +++ b/reference/fdp.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/fdp_resolve_read.html b/reference/fdp_resolve_read.html index 30039966..a2f9a16c 100644 --- a/reference/fdp_resolve_read.html +++ b/reference/fdp_resolve_read.html @@ -1,9 +1,9 @@ -fdp_resolve_read — fdp_resolve_read • rDataPipelinefdp_resolve_read — fdp_resolve_read • rDataPipeline - +
- +

fdp_resolve_read

- Source: R/fdp_resolve_read.R + Source: R/fdp_resolve_read.R
@@ -58,11 +58,13 @@

fdp_resolve_read

Arguments

-
this_read
+ + +
this_read

this_read

-
yaml
+
yaml

user written config file

@@ -79,15 +81,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/fdp_resolve_write.html b/reference/fdp_resolve_write.html index ef946773..2869b649 100644 --- a/reference/fdp_resolve_write.html +++ b/reference/fdp_resolve_write.html @@ -1,9 +1,9 @@ -fdp_resolve_write — fdp_resolve_write • rDataPipelinefdp_resolve_write — fdp_resolve_write • rDataPipeline - +
- +

fdp_resolve_write

- Source: R/fdp_resolve_write.R + Source: R/fdp_resolve_write.R
@@ -58,11 +58,13 @@

fdp_resolve_write

Arguments

-
this_write
+ + +
this_write

this_write

-
yaml
+
yaml

user written config file

@@ -79,15 +81,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/finalise.html b/reference/finalise.html index 5c734df9..69736edb 100644 --- a/reference/finalise.html +++ b/reference/finalise.html @@ -1,9 +1,9 @@ -Finalise code run — finalise • rDataPipelineFinalise code run — finalise • rDataPipeline - +
- +

Finalise code run

- Source: R/finalise.R + Source: R/finalise.R
@@ -58,16 +58,18 @@

Finalise code run

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
delete_if_empty
+
delete_if_empty

(optional) default is FALSE; see Details

-
delete_if_duplicate
+
delete_if_duplicate

(optional) default is FALSE; see Details

@@ -91,15 +93,15 @@

Details

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/find_read_match.html b/reference/find_read_match.html index 11013181..aaaa1bcc 100644 --- a/reference/find_read_match.html +++ b/reference/find_read_match.html @@ -1,9 +1,9 @@ -Find matching read aliases in config file — find_read_match • rDataPipelineFind matching read aliases in config file — find_read_match • rDataPipeline - +
- +

Find matching read aliases in config file

- Source: R/find_read_match.R + Source: R/find_read_match.R
@@ -58,12 +58,14 @@

Find matching read aliases in config file

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying the data product name

@@ -80,15 +82,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/find_write_match.html b/reference/find_write_match.html index 527b9b78..7aec4b5e 100644 --- a/reference/find_write_match.html +++ b/reference/find_write_match.html @@ -1,9 +1,9 @@ -Find matching write aliases in config file — find_write_match • rDataPipelineFind matching write aliases in config file — find_write_match • rDataPipeline - +
- +

Find matching write aliases in config file

- Source: R/find_write_match.R + Source: R/find_write_match.R
@@ -58,12 +58,14 @@

Find matching write aliases in config file

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying the data product name

@@ -80,15 +82,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/findme.html b/reference/findme.html index 402d832f..7c59b1f4 100644 --- a/reference/findme.html +++ b/reference/findme.html @@ -1,10 +1,10 @@ -findme — findme • rDataPipelinefindme — findme • rDataPipeline - +
- +

findme

- Source: R/findme.R + Source: R/findme.R
@@ -60,11 +60,13 @@

findme

Arguments

-
file
+ + +
file

file path

-
endpoint
+
endpoint

endpoint

@@ -81,15 +83,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_author_url.html b/reference/get_author_url.html index c195ff69..c5b6f727 100644 --- a/reference/get_author_url.html +++ b/reference/get_author_url.html @@ -1,9 +1,9 @@ -get_author_url — get_author_url • rDataPipelineget_author_url — get_author_url • rDataPipeline - +
- +

get_author_url

- Source: R/get_author_url.R + Source: R/get_author_url.R
@@ -58,7 +58,9 @@

get_author_url

Arguments

-
endpoint
+ + +
endpoint

a string specifying the registry endpoint

@@ -75,15 +77,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_components.html b/reference/get_components.html index 6033c8aa..00973db2 100644 --- a/reference/get_components.html +++ b/reference/get_components.html @@ -1,9 +1,9 @@ -Get H5 file components — get_components • rDataPipelineGet H5 file components — get_components • rDataPipeline - +
- +

Get H5 file components

- Source: R/get_components.R + Source: R/get_components.R
@@ -58,19 +58,19 @@

Get H5 file components

Arguments

-
filename
+ + +
filename

a string specifying a filename

Value

- - -

Returns the names of the items at the root of the file

+

Returns the names of the items at the root of the file

See also

-

Other get functions: +

Other get functions: get_entry(), get_existing(), get_file_hash(), @@ -89,15 +89,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_dataproduct.html b/reference/get_dataproduct.html index 3065b677..c99f697a 100644 --- a/reference/get_dataproduct.html +++ b/reference/get_dataproduct.html @@ -1,9 +1,9 @@ -get_dataproduct — get_dataproduct • rDataPipelineget_dataproduct — get_dataproduct • rDataPipeline - +
- +

get_dataproduct

- Source: R/get_dataproduct.R + Source: R/get_dataproduct.R
@@ -63,19 +63,21 @@

get_dataproduct

Arguments

-
data_product
+ + +
data_product

data_product

-
version
+
version

version

-
namespace
+
namespace

namespace

-
endpoint
+
endpoint

endpoint

@@ -92,15 +94,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_entity.html b/reference/get_entity.html index d7f5a320..bb30841a 100644 --- a/reference/get_entity.html +++ b/reference/get_entity.html @@ -1,9 +1,9 @@ -Get entity from url — get_entity • rDataPipelineGet entity from url — get_entity • rDataPipeline - +
- +

Get entity from url

- Source: R/get_entity.R + Source: R/get_entity.R
@@ -58,7 +58,9 @@

Get entity from url

Arguments

-
url
+ + +
url

a string specifying the url of an entry

@@ -75,15 +77,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_entry.html b/reference/get_entry.html index c71f29ed..9d3efcb4 100644 --- a/reference/get_entry.html +++ b/reference/get_entry.html @@ -1,9 +1,9 @@ -Return all fields associated with a table entry in the data registry — get_entry • rDataPipelineReturn all fields associated with a table entry in the data registry — get_entry • rDataPipeline - +
- +

Return all fields associated with a table entry in the data registry

- Source: R/get_entry.R + Source: R/get_entry.R
@@ -58,28 +58,28 @@

Return all fields associated with a table entry in the data registry

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
query
+
query

a list containing a valid query for the table, e.g. list(field = value)

-
endpoint
+
endpoint

a string specifying the registry endpoint

Value

- - -

Returns a list of fields present in the specified entry

+

Returns a list of fields present in the specified entry

See also

-

Other get functions: +

Other get functions: get_components(), get_existing(), get_file_hash(), @@ -98,15 +98,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_existing.html b/reference/get_existing.html index 5c87486b..e5f8c772 100644 --- a/reference/get_existing.html +++ b/reference/get_existing.html @@ -1,9 +1,9 @@ -Return all entries posted to a table in the data registry — get_existing • rDataPipelineReturn all entries posted to a table in the data registry — get_existing • rDataPipeline - +
- +

Return all entries posted to a table in the data registry

- Source: R/get_existing.R + Source: R/get_existing.R
@@ -63,34 +63,34 @@

Return all entries posted to a table in the data registry

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
limit_results
+
limit_results

a boolean specifying whether or not to limit the results, default is TRUE

-
detail
+
detail

a string specifying what level of detail to return; options are "all" for all details or "id" for just URL and IDs

-
endpoint
+
endpoint

a string specifying the registry endpoint

Value

- - -

Returns a data.frame of entries in table, default is limited +

Returns a data.frame of entries in table, default is limited to 100 entries

See also

-

Other get functions: +

Other get functions: get_components(), get_entry(), get_file_hash(), @@ -109,15 +109,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_fields.html b/reference/get_fields.html index bed01c36..2c012ba5 100644 --- a/reference/get_fields.html +++ b/reference/get_fields.html @@ -1,9 +1,9 @@ -Get fields from table — get_fields • rDataPipelineGet fields from table — get_fields • rDataPipeline - +
- +

Get fields from table

- Source: R/get_fields.R + Source: R/get_fields.R
@@ -58,19 +58,19 @@

Get fields from table

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
endpoint
+
endpoint

a string specifying the registry endpoint

Value

- - -

Returns a data.frame of fields and their attributes set to +

Returns a data.frame of fields and their attributes set to "none"

@@ -86,15 +86,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_file_hash.html b/reference/get_file_hash.html index 667c73c8..ace528ef 100644 --- a/reference/get_file_hash.html +++ b/reference/get_file_hash.html @@ -1,9 +1,9 @@ -Calculate hash from file — get_file_hash • rDataPipelineCalculate hash from file — get_file_hash • rDataPipeline - +
- +

Calculate hash from file

- Source: R/get_file_hash.R + Source: R/get_file_hash.R
@@ -58,13 +58,15 @@

Calculate hash from file

Arguments

-
filename
+ + +
filename

a string specifying a filename

See also

-

Other get functions: +

Other get functions: get_components(), get_entry(), get_existing(), @@ -83,15 +85,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_github_hash.html b/reference/get_github_hash.html index 80f16562..808a89a1 100644 --- a/reference/get_github_hash.html +++ b/reference/get_github_hash.html @@ -1,11 +1,11 @@ -Get current GitHub hash — get_github_hash • rDataPipelineGet current GitHub hash — get_github_hash • rDataPipeline - +
- +

Get current GitHub hash

- Source: R/get_github_hash.R + Source: R/get_github_hash.R
@@ -62,13 +62,15 @@

Get current GitHub hash

Arguments

-
repo
+ + +
repo

a string specifying the github username/repository

See also

-

Other get functions: +

Other get functions: get_components(), get_entry(), get_existing(), @@ -87,15 +89,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_id.html b/reference/get_id.html index e2c3067d..28065093 100644 --- a/reference/get_id.html +++ b/reference/get_id.html @@ -1,9 +1,9 @@ -Get ID — get_id • rDataPipelineGet ID — get_id • rDataPipeline - +
- +

Get ID

- Source: R/get_id.R + Source: R/get_id.R
@@ -58,24 +58,24 @@

Get ID

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
query
+
query

a list containing a valid query for the table, e.g. list(field = value)

-
endpoint
+
endpoint

a string specifying the registry endpoint

Value

- - -

Returns a string or list of strings specifying the URL or URLs of +

Returns a string or list of strings specifying the URL or URLs of entries in a table

@@ -91,15 +91,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_index.html b/reference/get_index.html index 9b964083..5750583d 100644 --- a/reference/get_index.html +++ b/reference/get_index.html @@ -1,9 +1,9 @@ -get_index — get_index • rDataPipelineget_index — get_index • rDataPipeline - +
- +

get_index

- Source: R/get_index.R + Source: R/get_index.R
@@ -58,11 +58,13 @@

get_index

Arguments

-
write
+ + +
write

write

-
data_product
+
data_product

data_product

@@ -79,15 +81,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_max_version.html b/reference/get_max_version.html index da575477..7b0ffee4 100644 --- a/reference/get_max_version.html +++ b/reference/get_max_version.html @@ -1,9 +1,9 @@ -get_max_version — get_max_version • rDataPipelineget_max_version — get_max_version • rDataPipeline - +
- +

get_max_version

- Source: R/get_max_version.R + Source: R/get_max_version.R
@@ -58,11 +58,13 @@

get_max_version

Arguments

-
data_product
+ + +
data_product

data_product

-
namespace_id
+
namespace_id

namespace_id

@@ -79,15 +81,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_storage_location.html b/reference/get_storage_location.html index a1c0c359..3674b730 100644 --- a/reference/get_storage_location.html +++ b/reference/get_storage_location.html @@ -1,9 +1,9 @@ -Get storage location from url — get_storage_location • rDataPipelineGet storage location from url — get_storage_location • rDataPipeline - +
- +

Get storage location from url

- Source: R/get_storage_location.R + Source: R/get_storage_location.R
@@ -58,15 +58,15 @@

Get storage location from url

Arguments

-
location
+ + +
location

the url of an entry in the storage_location table

Value

- - -

Returns a list of fields associated with the specified entry

+

Returns a list of fields associated with the specified entry

@@ -81,15 +81,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_table_optional.html b/reference/get_table_optional.html index 1f53f326..7c073f30 100644 --- a/reference/get_table_optional.html +++ b/reference/get_table_optional.html @@ -1,9 +1,9 @@ -Get optional fields — get_table_optional • rDataPipelineGet optional fields — get_table_optional • rDataPipeline - +
- +

Get optional fields

- Source: R/get_table_optional.R + Source: R/get_table_optional.R
@@ -58,19 +58,19 @@

Get optional fields

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
endpoint
+
endpoint

a string specifying the registry endpoint

Value

- - -

Returns a data.frame of optional fields and their properties

+

Returns a data.frame of optional fields and their properties

@@ -85,15 +85,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_table_queryable.html b/reference/get_table_queryable.html index 13e73977..88720ca8 100644 --- a/reference/get_table_queryable.html +++ b/reference/get_table_queryable.html @@ -1,9 +1,9 @@ -Get queryable fields — get_table_queryable • rDataPipelineGet queryable fields — get_table_queryable • rDataPipeline - +
- +

Get queryable fields

- Source: R/get_table_queryable.R + Source: R/get_table_queryable.R
@@ -58,19 +58,19 @@

Get queryable fields

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
endpoint
+
endpoint

a string specifying the registry endpoint

Value

- - -

Returns a character vector of queryable fields

+

Returns a character vector of queryable fields

@@ -85,15 +85,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_table_readable.html b/reference/get_table_readable.html index 41b0c2b9..0bfffc22 100644 --- a/reference/get_table_readable.html +++ b/reference/get_table_readable.html @@ -1,9 +1,9 @@ -Get readable fields — get_table_readable • rDataPipelineGet readable fields — get_table_readable • rDataPipeline - +
- +

Get readable fields

- Source: R/get_table_readable.R + Source: R/get_table_readable.R
@@ -58,19 +58,19 @@

Get readable fields

Arguments

-
table
+ + +
table

name of table

-
endpoint
+
endpoint

a string specifying the registry endpoint

Value

- - -

a dataframe of readable fields and their properties

+

a dataframe of readable fields and their properties

@@ -85,15 +85,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_table_required.html b/reference/get_table_required.html index d069f945..75cf867d 100644 --- a/reference/get_table_required.html +++ b/reference/get_table_required.html @@ -1,9 +1,9 @@ -Get required fields — get_table_required • rDataPipelineGet required fields — get_table_required • rDataPipeline - +
- +

Get required fields

- Source: R/get_table_required.R + Source: R/get_table_required.R
@@ -58,15 +58,15 @@

Get required fields

Arguments

-
table
+ + +
table

name of table

Value

- - -

a dataframe of required fields and their properties

+

a dataframe of required fields and their properties

@@ -81,15 +81,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_table_writable.html b/reference/get_table_writable.html index fd780196..53ed995c 100644 --- a/reference/get_table_writable.html +++ b/reference/get_table_writable.html @@ -1,9 +1,9 @@ -Get writable fields — get_table_writable • rDataPipelineGet writable fields — get_table_writable • rDataPipeline - +
- +

Get writable fields

- Source: R/get_table_writable.R + Source: R/get_table_writable.R
@@ -58,19 +58,19 @@

Get writable fields

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
endpoint
+
endpoint

a string specifying the registry endpoint

Value

- - -

Returns a character vector of writable fields

+

Returns a character vector of writable fields

@@ -85,15 +85,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_tables.html b/reference/get_tables.html index e3a9d7c5..1222bddd 100644 --- a/reference/get_tables.html +++ b/reference/get_tables.html @@ -1,9 +1,9 @@ -Get tables from registry — get_tables • rDataPipelineGet tables from registry — get_tables • rDataPipeline - +
- +

Get tables from registry

- Source: R/get_tables.R + Source: R/get_tables.R
@@ -58,15 +58,15 @@

Get tables from registry

Arguments

-
endpoint
+ + +
endpoint

a string specifying the registry endpoint

Value

- - -

a character vector of tables

+

a character vector of tables

@@ -81,15 +81,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_token.html b/reference/get_token.html index 5a181eb3..d94bbeab 100644 --- a/reference/get_token.html +++ b/reference/get_token.html @@ -1,9 +1,9 @@ -get_token — get_token • rDataPipelineget_token — get_token • rDataPipeline - +
- +

get_token

- Source: R/get_token.R + Source: R/get_token.R
@@ -69,15 +69,15 @@

get_token

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_url.html b/reference/get_url.html index 6cdb0d36..517156d3 100644 --- a/reference/get_url.html +++ b/reference/get_url.html @@ -1,9 +1,9 @@ -Get URL — get_url • rDataPipelineGet URL — get_url • rDataPipeline - +
- +

Get URL

- Source: R/get_url.R + Source: R/get_url.R
@@ -58,24 +58,24 @@

Get URL

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
query
+
query

a list containing a valid query for the table, e.g. list(field = value)

-
endpoint
+
endpoint

a string specifying the registry endpoint

Value

- - -

Returns a string or list of strings specifying the URL or URLs of +

Returns a string or list of strings specifying the URL or URLs of entries in a table

@@ -91,15 +91,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/github_files.html b/reference/github_files.html index 3a7caa36..f4a97a3c 100644 --- a/reference/github_files.html +++ b/reference/github_files.html @@ -1,9 +1,9 @@ -List files in GitHub repository — github_files • rDataPipelineList files in GitHub repository — github_files • rDataPipeline - +
- +

List files in GitHub repository

- Source: R/github_files.R + Source: R/github_files.R
@@ -58,7 +58,9 @@

List files in GitHub repository

Arguments

-
repo
+ + +
repo

a string specifying the github username/repository

@@ -75,15 +77,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/increment_filename.html b/reference/increment_filename.html index 424a6da2..8d90f3ea 100644 --- a/reference/increment_filename.html +++ b/reference/increment_filename.html @@ -1,9 +1,9 @@ -increment_filename — increment_filename • rDataPipelineincrement_filename — increment_filename • rDataPipeline - +
- +

increment_filename

- Source: R/increment_filename.R + Source: R/increment_filename.R
@@ -58,7 +58,9 @@

increment_filename

Arguments

-
path
+ + +
path

path

@@ -75,15 +77,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/index.html b/reference/index.html index 6316301f..c2c30051 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,9 +1,9 @@ -Function reference • rDataPipelinePackage index • rDataPipeline - +
- +
@@ -151,15 +151,15 @@

Misc

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/initialise.html b/reference/initialise.html index c69026bb..abb988dd 100644 --- a/reference/initialise.html +++ b/reference/initialise.html @@ -1,10 +1,10 @@ -Initialise code run — initialise • rDataPipelineInitialise code run — initialise • rDataPipeline - +
- +

Initialise code run

- Source: R/initialise.R + Source: R/initialise.R
@@ -60,21 +60,21 @@

Initialise code run

Arguments

-
config
+ + +
config

a string specifying the location of the working config file in the data store

-
script
+
script

a string specifying the location of the submission script in the data store

Value

- - -

Returns an object of class fdp, R6 containing metadata +

Returns an object of class fdp, R6 containing metadata required by the Data Pipeline API

@@ -90,15 +90,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/is_queryable.html b/reference/is_queryable.html index db2cab03..b874aa22 100644 --- a/reference/is_queryable.html +++ b/reference/is_queryable.html @@ -1,9 +1,9 @@ -Check whether fields are queryable — is_queryable • rDataPipelineCheck whether fields are queryable — is_queryable • rDataPipeline - +
- +

Check whether fields are queryable

- Source: R/is_queryable.R + Source: R/is_queryable.R
@@ -58,27 +58,27 @@

Check whether fields are queryable

Arguments

-
table
+ + +
table

a string specifying the name of the table

-
query
+
query

a list containing the query

-
method
+
method

a string specifying the method, c("GET", "POST")

-
endpoint
+
endpoint

endpoint

Value

- - -

Returns TRUE if the entry is queryable and FALSE if it +

Returns TRUE if the entry is queryable and FALSE if it isn't

@@ -94,15 +94,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/link_read.html b/reference/link_read.html index 2c67d52e..fcf4081a 100644 --- a/reference/link_read.html +++ b/reference/link_read.html @@ -1,9 +1,9 @@ -Link path to external format data — link_read • rDataPipelineLink path to external format data — link_read • rDataPipeline - +
- +

Link path to external format data

- Source: R/link_read.R + Source: R/link_read.R
@@ -58,21 +58,21 @@

Link path to external format data

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string representing an external object in the config.yaml file

Value

- - -

Returns a string specifying the location of the data product +

Returns a string specifying the location of the data product to be read

@@ -88,15 +88,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/link_write.html b/reference/link_write.html index 5771558f..ba61bc49 100644 --- a/reference/link_write.html +++ b/reference/link_write.html @@ -1,9 +1,9 @@ -Link path for external format data — link_write • rDataPipelineLink path for external format data — link_write • rDataPipeline - +
- +

Link path for external format data

- Source: R/link_write.R + Source: R/link_write.R
@@ -58,21 +58,21 @@

Link path for external format data

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string representing an external object in the config.yaml file

Value

- - -

Returns a string specifying the location in which the data +

Returns a string specifying the location in which the data product should be written

@@ -88,15 +88,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_author.html b/reference/new_author.html index ca75a3a1..69ff4760 100644 --- a/reference/new_author.html +++ b/reference/new_author.html @@ -1,9 +1,9 @@ -Post entry to author table — new_author • rDataPipelinePost entry to author table — new_author • rDataPipeline - +
- +

Post entry to author table

- Source: R/new_author.R + Source: R/new_author.R
@@ -58,24 +58,26 @@

Post entry to author table

Arguments

-
name
+ + +
name

a string specifying the full name or organisation name of the author; note that at least one of name or identifier must be specified

-
identifier
+
identifier

(optional) a string specifying the full URL identifier (e.g. ORCiD or ROR ID) of the author

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_code_repo_release(), new_code_run(), new_data_product(), @@ -105,15 +107,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_code_repo_release.html b/reference/new_code_repo_release.html index 7d583ad0..87e35ae3 100644 --- a/reference/new_code_repo_release.html +++ b/reference/new_code_repo_release.html @@ -1,9 +1,9 @@ -Post entry to code_repo_release table — new_code_repo_release • rDataPipelinePost entry to code_repo_release table — new_code_repo_release • rDataPipeline - +
- +

Post entry to code_repo_release table

- Source: R/new_code_repo_release.R + Source: R/new_code_repo_release.R
@@ -64,32 +64,34 @@

Post entry to code_repo_release table

Arguments

-
name
+ + +
name

a string specifying the name of an official release of code

-
version
+
version

a string specifying the version release (conforming with semantic versioning syntax)

-
object_url
+
object_url

a string specifying the URL of an object

-
website
+
website

(optional) a string specifying the URL of the website for this code release

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_run(), new_data_product(), @@ -119,15 +121,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_code_run.html b/reference/new_code_run.html index f4653ab0..0af9e369 100644 --- a/reference/new_code_run.html +++ b/reference/new_code_run.html @@ -1,9 +1,9 @@ -Post entry to code_run table — new_code_run • rDataPipelinePost entry to code_run table — new_code_run • rDataPipeline - +
- +

Post entry to code_run table

- Source: R/new_code_run.R + Source: R/new_code_run.R
@@ -67,50 +67,52 @@

Post entry to code_run table

Arguments

-
run_date
+ + +
run_date

the date-time of the code_run e.g. Sys.time() or "2010-07-11 12:15:00 BST"

-
description
+
description

(optional) a string containing a free text description of the code_run

-
code_repo_url
+
code_repo_url

(optional) a string specifying the URL of an object associated with the code_repo_release that was run

-
model_config_url
+
model_config_url

(optional) a string specifying the URL of an object associated with the working config file used for the code_run

-
submission_script_url
+
submission_script_url

(optional) a string specifying the URL of an object associated with the submission script used for the code_run

-
inputs_urls
+
inputs_urls

a list of object_component URLs referencing code_run inputs

-
outputs_urls
+
outputs_urls

a list of object_component URLs referencing code_run outputs

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_data_product(), @@ -140,15 +142,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_data_product.html b/reference/new_data_product.html index 66bbbba4..3a9abc0b 100644 --- a/reference/new_data_product.html +++ b/reference/new_data_product.html @@ -1,9 +1,9 @@ -Post entry to data_product table — new_data_product • rDataPipelinePost entry to data_product table — new_data_product • rDataPipeline - +
- +

Post entry to data_product table

- Source: R/new_data_product.R + Source: R/new_data_product.R
@@ -64,32 +64,34 @@

Post entry to data_product table

Arguments

-
name
+ + +
name

a string specifying the name of the data_product

-
version
+
version

a string specifying the version identifier of the data_product (must conform to semantic versioning syntax)

-
object_url
+
object_url

a string specifying the URL of the entry in the object table

-
namespace_url
+
namespace_url

a string specifying the URL of the entry in the namespace table

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -119,15 +121,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_external_object.html b/reference/new_external_object.html index b93e8b8f..0f733fed 100644 --- a/reference/new_external_object.html +++ b/reference/new_external_object.html @@ -1,9 +1,9 @@ -Post entry to external_object table — new_external_object • rDataPipelinePost entry to external_object table — new_external_object • rDataPipeline - +
- +

Post entry to external_object table

- Source: R/new_external_object.R + Source: R/new_external_object.R
@@ -67,49 +67,51 @@

Post entry to external_object table

Arguments

-
doi_or_unique_name
+ + +
doi_or_unique_name

a string specifying the DOI or name of the external_object

-
primary_not_supplement
+
primary_not_supplement

(optional) a boolean flag to indicate whether the external object is the primary source (TRUE) or not (FALSE)

-
release_date
+
release_date

the date-time that the external_object was released e.g. Sys.time() or "2010-07-11 12:15:00 BST"

-
title
+
title

a string specifying the title of the external_object

-
description
+
description

(optional) a string containing a free text description of the external_object

-
data_product_url
+
data_product_url

a string specifying the URL of an entry in the data_product table

-
original_store_url
+
original_store_url

(optional) a string specifying the URL of a an entry in the storage_location table that references the original location of an external_object

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -139,15 +141,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_file_type.html b/reference/new_file_type.html index e6e0ea7e..c281692d 100644 --- a/reference/new_file_type.html +++ b/reference/new_file_type.html @@ -1,9 +1,9 @@ -Post entry to file_type table — new_file_type • rDataPipelinePost entry to file_type table — new_file_type • rDataPipeline - +
- +

Post entry to file_type table

- Source: R/new_file_type.R + Source: R/new_file_type.R
@@ -58,21 +58,23 @@

Post entry to file_type table

Arguments

-
name
+ + +
name

a string specifying the name of the file type

-
extension
+
extension

a string specifying the filename extension

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -102,15 +104,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_issue.html b/reference/new_issue.html index c2e5f1df..93efe93c 100644 --- a/reference/new_issue.html +++ b/reference/new_issue.html @@ -1,9 +1,9 @@ -Post entry to issue table — new_issue • rDataPipelinePost entry to issue table — new_issue • rDataPipeline - +
- +

Post entry to issue table

- Source: R/new_issue.R + Source: R/new_issue.R
@@ -63,27 +63,29 @@

Post entry to issue table

Arguments

-
severity
+ + +
severity

an integer specifying the severity of the issue

-
description
+
description

a string containing a free text description of the issue

-
component_issues
+
component_issues

a list of object_component URLs with which the issue is associated; this can be an empty list

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -113,15 +115,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_keyword.html b/reference/new_keyword.html index 301acf01..c0325cd9 100644 --- a/reference/new_keyword.html +++ b/reference/new_keyword.html @@ -1,9 +1,9 @@ -Post entry to keyword table — new_keyword • rDataPipelinePost entry to keyword table — new_keyword • rDataPipeline - +
- +

Post entry to keyword table

- Source: R/new_keyword.R + Source: R/new_keyword.R
@@ -63,27 +63,29 @@

Post entry to keyword table

Arguments

-
object_url
+ + +
object_url

a string specifying the URL of an object

-
keyphrase
+
keyphrase

a string a string containing a free text key phrase

-
identifier
+
identifier

(optional) a string specifying the URL of ontology annotation to associate with this keyword

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -113,15 +115,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_licence.html b/reference/new_licence.html index bf36b12a..c6ad12f2 100644 --- a/reference/new_licence.html +++ b/reference/new_licence.html @@ -1,9 +1,9 @@ -Post entry to licence table — new_licence • rDataPipelinePost entry to licence table — new_licence • rDataPipeline - +
- +

Post entry to licence table

- Source: R/new_licence.R + Source: R/new_licence.R
@@ -58,22 +58,24 @@

Post entry to licence table

Arguments

-
object_url
+ + +
object_url

a string specifying the URL of an object

-
licence_info
+
licence_info

a free text string containing information about the licence

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -103,15 +105,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_namespace.html b/reference/new_namespace.html index 9fbaea7a..12c4aa5c 100644 --- a/reference/new_namespace.html +++ b/reference/new_namespace.html @@ -1,9 +1,9 @@ -Post entry to namespace table — new_namespace • rDataPipelinePost entry to namespace table — new_namespace • rDataPipeline - +
- +

Post entry to namespace table

- Source: R/new_namespace.R + Source: R/new_namespace.R
@@ -63,27 +63,29 @@

Post entry to namespace table

Arguments

-
name
+ + +
name

a string specifying the name of the namespace

-
full_name
+
full_name

(optional) a string specifying the full name of the namespace

-
website
+
website

(optional) a string specifying the website URL associated with the namespace

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -113,15 +115,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_object.html b/reference/new_object.html index efd3248a..55317ca6 100644 --- a/reference/new_object.html +++ b/reference/new_object.html @@ -1,9 +1,9 @@ -Post entry to object table — new_object • rDataPipelinePost entry to object table — new_object • rDataPipeline - +
- +

Post entry to object table

- Source: R/new_object.R + Source: R/new_object.R
@@ -64,33 +64,35 @@

Post entry to object table

Arguments

-
description
+ + +
description

(optional) a string containing a free text description of the object

-
storage_location_url
+
storage_location_url

(optional) a string specifying the URL of an entry in the storage_location table

-
authors_url
+
authors_url

(optional) a list of author URLs associated with this object

-
file_type_url
+
file_type_url

(optional) a string specifying the URL of an entry in the file_type table

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -120,15 +122,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_object_component.html b/reference/new_object_component.html index 072aa46f..fc8ef5d6 100644 --- a/reference/new_object_component.html +++ b/reference/new_object_component.html @@ -1,9 +1,9 @@ -Post entry to object_component table — new_object_component • rDataPipelinePost entry to object_component table — new_object_component • rDataPipeline - +
- +

Post entry to object_component table

- Source: R/new_object_component.R + Source: R/new_object_component.R
@@ -65,34 +65,36 @@

Post entry to object_component table

Arguments

-
object_url
+ + +
object_url

a string specifying the URL of an existing object

-
name
+
name

a string specifying the name of the object_component, unique in the context of object_component and its object reference

-
description
+
description

(optional) a string containing a free text description of the object_component

-
whole_object
+
whole_object

a boolean flag specifying whether or not this object_component refers to the whole object or not - default is FALSE

-
issues_urls
+
issues_urls

(optional) a list of issues URLs to associate with this object

-
endpoint
+
endpoint

a string specifying the registry endpoint

Note that the object_component table contains issues as an additional optional field. This is not included here. Instead use @@ -102,7 +104,7 @@

Arguments

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -132,15 +134,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_quality_controlled.html b/reference/new_quality_controlled.html index a996dbd9..f3c829fd 100644 --- a/reference/new_quality_controlled.html +++ b/reference/new_quality_controlled.html @@ -1,10 +1,10 @@ -Post entry to quality_controlled table — new_quality_controlled • rDataPipelinePost entry to quality_controlled table — new_quality_controlled • rDataPipeline - +
- +

Post entry to quality_controlled table

- Source: R/new_quality_controlled.R + Source: R/new_quality_controlled.R
@@ -60,17 +60,19 @@

Post entry to quality_controlled table

Arguments

-
object_url
+ + +
object_url

a string specifying the URL of an object

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -100,15 +102,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_storage_location.html b/reference/new_storage_location.html index bcd1509d..07f65102 100644 --- a/reference/new_storage_location.html +++ b/reference/new_storage_location.html @@ -1,9 +1,9 @@ -Post entry to storage_location table — new_storage_location • rDataPipelinePost entry to storage_location table — new_storage_location • rDataPipeline - +
- +

Post entry to storage_location table

- Source: R/new_storage_location.R + Source: R/new_storage_location.R
@@ -64,34 +64,36 @@

Post entry to storage_location table

Arguments

-
path
+ + +
path

a string specifying the path from the storage_root URI to the item location, which when appended to storage_root URI produces a complete URL

-
hash
+
hash

a string specifying the SHA1 hash of a file stored in storage_location

-
public
+
public

a boolean indicating whether the storage_location is public or not (default is TRUE)

-
storage_root_url
+
storage_root_url

a string specifying the URL of an entry in the storage_root table

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -121,15 +123,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_storage_root.html b/reference/new_storage_root.html index 59b7684e..72b9ded7 100644 --- a/reference/new_storage_root.html +++ b/reference/new_storage_root.html @@ -1,9 +1,9 @@ -Post entry to storage_root table — new_storage_root • rDataPipelinePost entry to storage_root table — new_storage_root • rDataPipeline - +
- +

Post entry to storage_root table

- Source: R/new_storage_root.R + Source: R/new_storage_root.R
@@ -58,24 +58,26 @@

Post entry to storage_root table

Arguments

-
root
+ + +
root

a string specifying the URI of a storage_location, which when prepended to a storage_location produces a complete URI to a file

-
local
+
local

(optional) a boolean indicating whether the storage_root is local or not

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -105,15 +107,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/new_user_author.html b/reference/new_user_author.html index b2243f33..4c57a98c 100644 --- a/reference/new_user_author.html +++ b/reference/new_user_author.html @@ -1,9 +1,9 @@ -Post entry to user_author table — new_user_author • rDataPipelinePost entry to user_author table — new_user_author • rDataPipeline - +
- +

Post entry to user_author table

- Source: R/new_user_author.R + Source: R/new_user_author.R
@@ -58,23 +58,25 @@

Post entry to user_author table

Arguments

-
user_url
+ + +
user_url

a string specifying the URL of an existing user

-
author_url
+
author_url

a string specifying the URL of an existing author

-
endpoint
+
endpoint

a string specifying the registry endpoint

See also

-

Other new functions: +

Other new functions: new_author(), new_code_repo_release(), new_code_run(), @@ -104,15 +106,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/paper_exists.html b/reference/paper_exists.html index e80b1ea4..05513f4c 100644 --- a/reference/paper_exists.html +++ b/reference/paper_exists.html @@ -1,9 +1,9 @@ -Check whether paper exists — paper_exists • rDataPipelineCheck whether paper exists — paper_exists • rDataPipeline - +
- +

Check whether paper exists

- Source: R/paper_exists.R + Source: R/paper_exists.R
@@ -58,7 +58,9 @@

Check whether paper exists

Arguments

-
doi
+ + +
doi

doi

@@ -75,15 +77,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/patch_data.html b/reference/patch_data.html index 6772acb7..047a63fe 100644 --- a/reference/patch_data.html +++ b/reference/patch_data.html @@ -1,9 +1,9 @@ -Patch entry in data registry — patch_data • rDataPipelinePatch entry in data registry — patch_data • rDataPipeline - +
- +

Patch entry in data registry

- Source: R/patch_data.R + Source: R/patch_data.R
@@ -58,11 +58,13 @@

Patch entry in data registry

Arguments

-
url
+ + +
url

url

-
data
+
data

data

@@ -79,15 +81,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/post_data.html b/reference/post_data.html index 050e8d00..f2646c36 100644 --- a/reference/post_data.html +++ b/reference/post_data.html @@ -1,9 +1,9 @@ -Post entry to data registry — post_data • rDataPipelinePost entry to data registry — post_data • rDataPipeline - +
- +

Post entry to data registry

- Source: R/post_data.R + Source: R/post_data.R
@@ -58,15 +58,17 @@

Post entry to data registry

Arguments

-
table
+ + +
table

table name as a character

-
data
+
data

data as a named list

-
endpoint
+
endpoint

a string specifying the registry endpoint

@@ -83,15 +85,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/rDataPipeline-package.html b/reference/rDataPipeline-package.html index 8ef2ba1e..9cd81ecc 100644 --- a/reference/rDataPipeline-package.html +++ b/reference/rDataPipeline-package.html @@ -1,9 +1,9 @@ -rDataPipeline — rDataPipeline-package • rDataPipelinerDataPipeline — rDataPipeline-package • rDataPipeline - +
- +

rDataPipeline

- Source: R/rDataPipeline-package.R + Source: R/rDataPipeline-package.R
@@ -71,15 +71,15 @@

Details

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/rDataPipeline.html b/reference/rDataPipeline.html new file mode 100644 index 00000000..854a8776 --- /dev/null +++ b/reference/rDataPipeline.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/raise_issue.html b/reference/raise_issue.html index d43a5d1f..8387bbea 100644 --- a/reference/raise_issue.html +++ b/reference/raise_issue.html @@ -1,9 +1,9 @@ -raise_issue — raise_issue • rDataPipelineraise_issue — raise_issue • rDataPipeline - +
- +

raise_issue

- Source: R/raise_issue.R + Source: R/raise_issue.R
@@ -66,32 +66,34 @@

raise_issue

Arguments

-
index
+ + +
index

index returned from link_*(), read_(), or write()

-
handle
+
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
component
+
component

a string specifying the component name

-
data_product
+
data_product

a string specifying the data product name

-
issue
+
issue

a string specifying the issue

-
severity
+
severity

a numeric value specifying the severity

-
whole_object
+
whole_object

a boolean flag specifying whether or not to reference the whole_object

@@ -109,15 +111,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/raise_issue_config.html b/reference/raise_issue_config.html index 23550b92..5c76a57b 100644 --- a/reference/raise_issue_config.html +++ b/reference/raise_issue_config.html @@ -1,9 +1,9 @@ -Raise issue with config file — raise_issue_config • rDataPipelineRaise issue with config file — raise_issue_config • rDataPipeline - +
- +

Raise issue with config file

- Source: R/raise_issue_config.R + Source: R/raise_issue_config.R
@@ -58,16 +58,18 @@

Raise issue with config file

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
issue
+
issue

a string specifying the issue

-
severity
+
severity

a numeric value specifying the severity

@@ -84,15 +86,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/raise_issue_repo.html b/reference/raise_issue_repo.html index d7192fff..c4d2e4a9 100644 --- a/reference/raise_issue_repo.html +++ b/reference/raise_issue_repo.html @@ -1,9 +1,9 @@ -Raise issue with remote repository — raise_issue_repo • rDataPipelineRaise issue with remote repository — raise_issue_repo • rDataPipeline - +
- +

Raise issue with remote repository

- Source: R/raise_issue_repo.R + Source: R/raise_issue_repo.R
@@ -58,16 +58,18 @@

Raise issue with remote repository

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
issue
+
issue

a string specifying the issue

-
severity
+
severity

a numeric value specifying the severity

@@ -84,15 +86,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/raise_issue_script.html b/reference/raise_issue_script.html index 96635e67..f0c48a60 100644 --- a/reference/raise_issue_script.html +++ b/reference/raise_issue_script.html @@ -1,9 +1,9 @@ -Raise issue with submission script — raise_issue_script • rDataPipelineRaise issue with submission script — raise_issue_script • rDataPipeline - +
- +

Raise issue with submission script

- Source: R/raise_issue_script.R + Source: R/raise_issue_script.R
@@ -58,16 +58,18 @@

Raise issue with submission script

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
issue
+
issue

a string specifying the issue

-
severity
+
severity

a numeric value specifying the severity

@@ -84,15 +86,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/random_hash.html b/reference/random_hash.html index a1831c67..679cde33 100644 --- a/reference/random_hash.html +++ b/reference/random_hash.html @@ -1,9 +1,9 @@ -random_hash — random_hash • rDataPipelinerandom_hash — random_hash • rDataPipeline - +
- +

random_hash

- Source: R/random_hash.R + Source: R/random_hash.R
@@ -69,15 +69,15 @@

random_hash

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/read_array.html b/reference/read_array.html index 650acaf1..a29dad02 100644 --- a/reference/read_array.html +++ b/reference/read_array.html @@ -1,9 +1,9 @@ -Read array component from HDF5 file — read_array • rDataPipelineRead array component from HDF5 file — read_array • rDataPipeline - +
- +

Read array component from HDF5 file

- Source: R/read_array.R + Source: R/read_array.R
@@ -58,28 +58,26 @@

Read array component from HDF5 file

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying a data product

-
component
+
component

a string specifying a data product component

Value

- - -

Returns an array with attached Dimension_i_title, -Dimension_i_units, Dimension_i_values, and units

- - -

attributes, if available

+

Returns an array with attached Dimension_i_title, +Dimension_i_units, Dimension_i_values, and units +attributes, if available

@@ -94,15 +92,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/read_distribution.html b/reference/read_distribution.html index eaf82792..9bd6948f 100644 --- a/reference/read_distribution.html +++ b/reference/read_distribution.html @@ -1,9 +1,9 @@ -Read distribution component from TOML file — read_distribution • rDataPipelineRead distribution component from TOML file — read_distribution • rDataPipeline - +
- +

Read distribution component from TOML file

- Source: R/read_distribution.R + Source: R/read_distribution.R
@@ -58,16 +58,18 @@

Read distribution component from TOML file

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying a data product

-
component
+
component

a string specifying a data product component

@@ -84,15 +86,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/read_estimate.html b/reference/read_estimate.html index 7bd94fae..442d0bee 100644 --- a/reference/read_estimate.html +++ b/reference/read_estimate.html @@ -1,9 +1,9 @@ -Read estimate component from TOML file — read_estimate • rDataPipelineRead estimate component from TOML file — read_estimate • rDataPipeline - +
- +

Read estimate component from TOML file

- Source: R/read_estimate.R + Source: R/read_estimate.R
@@ -58,16 +58,18 @@

Read estimate component from TOML file

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying a data product

-
component
+
component

a string specifying a data product component

@@ -84,15 +86,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/read_table.html b/reference/read_table.html index 0b50a604..d992e821 100644 --- a/reference/read_table.html +++ b/reference/read_table.html @@ -1,9 +1,9 @@ -Read table component from HDF5 file — read_table • rDataPipelineRead table component from HDF5 file — read_table • rDataPipeline - +
- +

Read table component from HDF5 file

- Source: R/read_table.R + Source: R/read_table.R
@@ -58,27 +58,25 @@

Read table component from HDF5 file

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying a data product

-
component
+
component

a string specifying a data product component

Value

- - -

Returns a data.frame with attached column_units

- - -

attributes, if available

+

Returns a data.frame with attached column_units +attributes, if available

@@ -93,15 +91,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/register_issue_dataproduct.html b/reference/register_issue_dataproduct.html index 254831a7..6532dd33 100644 --- a/reference/register_issue_dataproduct.html +++ b/reference/register_issue_dataproduct.html @@ -1,9 +1,9 @@ -register_issue_dataproduct — register_issue_dataproduct • rDataPipelineregister_issue_dataproduct — register_issue_dataproduct • rDataPipeline - +
- +

register_issue_dataproduct

- Source: R/register_issue_dataproduct.R + Source: R/register_issue_dataproduct.R
@@ -58,12 +58,14 @@

register_issue_dataproduct

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
this_issue
+
this_issue

this_issue

@@ -80,15 +82,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/register_issue_script.html b/reference/register_issue_script.html index 1ff85e1f..3a2b9df4 100644 --- a/reference/register_issue_script.html +++ b/reference/register_issue_script.html @@ -1,9 +1,9 @@ -register_issue_script — register_issue_script • rDataPipelineregister_issue_script — register_issue_script • rDataPipeline - +
- +

register_issue_script

- Source: R/register_issue_script.R + Source: R/register_issue_script.R
@@ -58,16 +58,18 @@

register_issue_script

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
this_issue
+
this_issue

this_issue

-
type
+
type

type

@@ -84,15 +86,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/remove_empty_parents.html b/reference/remove_empty_parents.html index 45d34da6..5c0d4c6c 100644 --- a/reference/remove_empty_parents.html +++ b/reference/remove_empty_parents.html @@ -1,9 +1,9 @@ -remove_empty_parents — remove_empty_parents • rDataPipelineremove_empty_parents — remove_empty_parents • rDataPipeline - +
- +

remove_empty_parents

- Source: R/remove_empty_parents.R + Source: R/remove_empty_parents.R
@@ -58,11 +58,13 @@

remove_empty_parents

Arguments

-
path
+ + +
path

path

-
root
+
root

root

@@ -79,15 +81,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/resolve_read.html b/reference/resolve_read.html index 5fafaa80..66f56092 100644 --- a/reference/resolve_read.html +++ b/reference/resolve_read.html @@ -1,9 +1,9 @@ -resolve_read — resolve_read • rDataPipelineresolve_read — resolve_read • rDataPipeline - +
- +

resolve_read

- Source: R/resolve_read.R + Source: R/resolve_read.R
@@ -58,16 +58,18 @@

resolve_read

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying the name of the data product

-
component
+
component

a string specifying the name of data product component

@@ -85,15 +87,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/resolve_version.html b/reference/resolve_version.html index 8f0fa551..647783bb 100644 --- a/reference/resolve_version.html +++ b/reference/resolve_version.html @@ -1,9 +1,9 @@ -resolve_version — resolve_version • rDataPipelineresolve_version — resolve_version • rDataPipeline - +
- +

resolve_version

- Source: R/resolve_version.R + Source: R/resolve_version.R
@@ -58,15 +58,17 @@

resolve_version

Arguments

-
version
+ + +
version

version number

-
data_product
+
data_product

data_product

-
namespace_id
+
namespace_id

namespace_id

@@ -83,15 +85,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/resolve_write.html b/reference/resolve_write.html index 6d9af42b..dc84d1c3 100644 --- a/reference/resolve_write.html +++ b/reference/resolve_write.html @@ -1,9 +1,9 @@ -resolve_data_product — resolve_write • rDataPipelineresolve_data_product — resolve_write • rDataPipeline - +
- +

resolve_data_product

- Source: R/resolve_write.R + Source: R/resolve_write.R
@@ -58,16 +58,18 @@

resolve_data_product

Arguments

-
handle
+ + +
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying the name of the data product

-
file_type
+
file_type

(optional) a string specifying the file type; when missing, file_type will be read from the config file

@@ -85,15 +87,15 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/validate_fields.html b/reference/validate_fields.html index 70d49186..834fae6a 100644 --- a/reference/validate_fields.html +++ b/reference/validate_fields.html @@ -1,9 +1,9 @@ -Validate fields — validate_fields • rDataPipelineValidate fields — validate_fields • rDataPipeline - +
- +

Validate fields

- Source: R/validate_fields.R + Source: R/validate_fields.R
@@ -58,23 +58,23 @@

Validate fields

Arguments

-
table
+ + +
table

table name as character

-
data
+
data

data as a named list

-
endpoint
+
endpoint

endpoint

Value

- - -

Returns

+

Returns

@@ -89,15 +89,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/write_array.html b/reference/write_array.html index d0d844eb..89d46494 100644 --- a/reference/write_array.html +++ b/reference/write_array.html @@ -1,9 +1,9 @@ -Write array component to HDF5 file — write_array • rDataPipelineWrite array component to HDF5 file — write_array • rDataPipeline - +
- +

Write array component to HDF5 file

- Source: R/write_array.R + Source: R/write_array.R
@@ -68,28 +68,30 @@

Write array component to HDF5 file

Arguments

-
array
+ + +
array

an array containing the data

-
handle
+
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying the name of the data product

-
component
+
component

a string specifying a location within the hdf5 file

-
description
+
description

a string describing the data product component

-
dimension_names
+
dimension_names

a list where each element is a vector containing the labels associated with a particular dimension (e.g. element 1 corresponds to dimension 1, which corresponds to row names) and @@ -97,31 +99,29 @@

Arguments

classes).

-
dimension_values
+
dimension_values

(optional) a list of values corresponding to each dimension (e.g. list element 2 corresponds to columns)

-
dimension_units
+
dimension_units

(optional) a list of units corresponding to each dimension (e.g. list element 2 corresponds to columns)

-
units
+
units

(optional) a string specifying the units of the data as a whole

Value

- - -

Returns a handle index associated with the just written component, +

Returns a handle index associated with the just written component, which can be used to raise an issue if necessary

See also

-

Other write functions: +

Other write functions: write_distribution(), write_estimate(), write_table()

@@ -139,15 +139,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/write_distribution.html b/reference/write_distribution.html index 8ee2863d..e7e0775a 100644 --- a/reference/write_distribution.html +++ b/reference/write_distribution.html @@ -1,9 +1,9 @@ -Write distribution component to TOML file — write_distribution • rDataPipelineWrite distribution component to TOML file — write_distribution • rDataPipeline - +
- +

Write distribution component to TOML file

- Source: R/write_distribution.R + Source: R/write_distribution.R
@@ -65,41 +65,41 @@

Write distribution component to TOML file

Arguments

-
distribution
+ + +
distribution

a string specifying the name of the distribution

-
parameters
+
parameters

a list specifying the distribution parameters

-
handle
+
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying the name of the data product

-
component
+
component

a string specifying a location within the toml file

-
description
+
description

a string describing the data product component

Value

- - -

Returns a handle index associated with the just written component, +

Returns a handle index associated with the just written component, which can be used to raise an issue if necessary

See also

-

Other write functions: +

Other write functions: write_array(), write_estimate(), write_table()

@@ -117,15 +117,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/write_estimate.html b/reference/write_estimate.html index b7b60df5..28f573d1 100644 --- a/reference/write_estimate.html +++ b/reference/write_estimate.html @@ -1,11 +1,11 @@ -Write estimate component to TOML file — write_estimate • rDataPipelineWrite estimate component to TOML file — write_estimate • rDataPipeline - +
- +

Write estimate component to TOML file

- Source: R/write_estimate.R + Source: R/write_estimate.R
@@ -62,37 +62,37 @@

Write estimate component to TOML file

Arguments

-
value
+ + +
value

an object of class numeric

-
handle
+
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying the name of the data product

-
component
+
component

a string specifying a location within the toml file

-
description
+
description

a string describing the data product component

Value

- - -

Returns a handle index associated with the just written component, +

Returns a handle index associated with the just written component, which can be used to raise an issue if necessary

See also

-

Other write functions: +

Other write functions: write_array(), write_distribution(), write_table()

@@ -110,15 +110,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/write_table.html b/reference/write_table.html index 70a165a6..9c8a337e 100644 --- a/reference/write_table.html +++ b/reference/write_table.html @@ -1,9 +1,9 @@ -Write table component to HDF5 file — write_table • rDataPipelineWrite table component to HDF5 file — write_table • rDataPipeline - +
- +

Write table component to HDF5 file

- Source: R/write_table.R + Source: R/write_table.R
@@ -66,45 +66,45 @@

Write table component to HDF5 file

Arguments

-
df
+ + +
df

an dataframe containing the data

-
handle
+
handle

an object of class fdp, R6 containing metadata required by the Data Pipeline API

-
data_product
+
data_product

a string specifying the name of the data product

-
component
+
component

a string specifying a location within the hdf5 file,

-
description
+
description

a string describing the data product component

-
row_names
+
row_names

(optional) a vector of rownames

-
column_units
+
column_units

(optional) a vector comprising column units

Value

- - -

Returns a handle index associated with the just written component, +

Returns a handle index associated with the just written component, which can be used to raise an issue if necessary

See also

-

Other write functions: +

Other write functions: write_array(), write_distribution(), write_estimate()

@@ -122,15 +122,15 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/sitemap.xml b/sitemap.xml index 3e8e862d..11f7c082 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1,315 +1,107 @@ - - - - https://www.fairdatapipeline.org/rDataPipeline/404.html - - - https://www.fairdatapipeline.org/rDataPipeline/LICENSE.html - - - https://www.fairdatapipeline.org/rDataPipeline/authors.html - - - https://www.fairdatapipeline.org/rDataPipeline/index.html - - - https://www.fairdatapipeline.org/rDataPipeline/news/index.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/add_read.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/add_write.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/check_config.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/check_dataproduct_exists.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/check_datetime.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/check_exists.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/check_field.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/check_fields.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/check_handle.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/check_integer.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/check_local_repo.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/check_string.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/check_table_exists.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/check_yaml_write.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/clean_query.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/create_config.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/create_index.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/create_version_number.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/download_from_database.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/download_from_url.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/extract_id.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/fair_init.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/fair_run.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/fdp-class.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/fdp_resolve_read.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/fdp_resolve_write.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/finalise.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/find_read_match.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/find_write_match.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/findme.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_author_url.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_components.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_dataproduct.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_entity.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_entry.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_existing.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_fields.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_file_hash.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_github_hash.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_id.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_index.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_max_version.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_storage_location.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_table_optional.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_table_queryable.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_table_readable.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_table_required.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_table_writable.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_tables.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_token.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/get_url.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/github_files.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/increment_filename.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/index.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/initialise.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/is_queryable.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/link_read.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/link_write.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_author.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_code_repo_release.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_code_run.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_data_product.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_external_object.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_file_type.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_issue.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_keyword.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_licence.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_namespace.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_object.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_object_component.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_quality_controlled.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_storage_location.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_storage_root.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/new_user_author.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/paper_exists.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/patch_data.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/post_data.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/rDataPipeline-package.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/raise_issue.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/raise_issue_config.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/raise_issue_repo.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/raise_issue_script.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/random_hash.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/read_array.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/read_distribution.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/read_estimate.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/read_table.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/register_issue_dataproduct.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/register_issue_script.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/remove_empty_parents.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/resolve_read.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/resolve_version.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/resolve_write.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/validate_fields.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/write_array.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/write_distribution.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/write_estimate.html - - - https://www.fairdatapipeline.org/rDataPipeline/reference/write_table.html - - - https://www.fairdatapipeline.org/rDataPipeline/software-checklist.html - + +https://www.fairdatapipeline.org/rDataPipeline/404.html +https://www.fairdatapipeline.org/rDataPipeline/LICENSE.html +https://www.fairdatapipeline.org/rDataPipeline/authors.html +https://www.fairdatapipeline.org/rDataPipeline/index.html +https://www.fairdatapipeline.org/rDataPipeline/news/index.html +https://www.fairdatapipeline.org/rDataPipeline/reference/add_read.html +https://www.fairdatapipeline.org/rDataPipeline/reference/add_write.html +https://www.fairdatapipeline.org/rDataPipeline/reference/check_config.html +https://www.fairdatapipeline.org/rDataPipeline/reference/check_dataproduct_exists.html +https://www.fairdatapipeline.org/rDataPipeline/reference/check_datetime.html +https://www.fairdatapipeline.org/rDataPipeline/reference/check_exists.html +https://www.fairdatapipeline.org/rDataPipeline/reference/check_field.html +https://www.fairdatapipeline.org/rDataPipeline/reference/check_fields.html +https://www.fairdatapipeline.org/rDataPipeline/reference/check_handle.html +https://www.fairdatapipeline.org/rDataPipeline/reference/check_integer.html +https://www.fairdatapipeline.org/rDataPipeline/reference/check_local_repo.html +https://www.fairdatapipeline.org/rDataPipeline/reference/check_string.html +https://www.fairdatapipeline.org/rDataPipeline/reference/check_table_exists.html +https://www.fairdatapipeline.org/rDataPipeline/reference/check_yaml_write.html +https://www.fairdatapipeline.org/rDataPipeline/reference/clean_query.html +https://www.fairdatapipeline.org/rDataPipeline/reference/create_config.html +https://www.fairdatapipeline.org/rDataPipeline/reference/create_index.html +https://www.fairdatapipeline.org/rDataPipeline/reference/create_version_number.html +https://www.fairdatapipeline.org/rDataPipeline/reference/download_from_database.html +https://www.fairdatapipeline.org/rDataPipeline/reference/download_from_url.html +https://www.fairdatapipeline.org/rDataPipeline/reference/extract_id.html +https://www.fairdatapipeline.org/rDataPipeline/reference/fair_init.html +https://www.fairdatapipeline.org/rDataPipeline/reference/fair_run.html +https://www.fairdatapipeline.org/rDataPipeline/reference/fdp-class.html +https://www.fairdatapipeline.org/rDataPipeline/reference/fdp_resolve_read.html +https://www.fairdatapipeline.org/rDataPipeline/reference/fdp_resolve_write.html +https://www.fairdatapipeline.org/rDataPipeline/reference/finalise.html +https://www.fairdatapipeline.org/rDataPipeline/reference/find_read_match.html +https://www.fairdatapipeline.org/rDataPipeline/reference/find_write_match.html +https://www.fairdatapipeline.org/rDataPipeline/reference/findme.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_author_url.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_components.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_dataproduct.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_entity.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_entry.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_existing.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_fields.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_file_hash.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_github_hash.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_id.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_index.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_max_version.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_storage_location.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_table_optional.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_table_queryable.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_table_readable.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_table_required.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_table_writable.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_tables.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_token.html +https://www.fairdatapipeline.org/rDataPipeline/reference/get_url.html +https://www.fairdatapipeline.org/rDataPipeline/reference/github_files.html +https://www.fairdatapipeline.org/rDataPipeline/reference/increment_filename.html +https://www.fairdatapipeline.org/rDataPipeline/reference/index.html +https://www.fairdatapipeline.org/rDataPipeline/reference/initialise.html +https://www.fairdatapipeline.org/rDataPipeline/reference/is_queryable.html +https://www.fairdatapipeline.org/rDataPipeline/reference/link_read.html +https://www.fairdatapipeline.org/rDataPipeline/reference/link_write.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_author.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_code_repo_release.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_code_run.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_data_product.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_external_object.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_file_type.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_issue.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_keyword.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_licence.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_namespace.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_object.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_object_component.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_quality_controlled.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_storage_location.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_storage_root.html +https://www.fairdatapipeline.org/rDataPipeline/reference/new_user_author.html +https://www.fairdatapipeline.org/rDataPipeline/reference/paper_exists.html +https://www.fairdatapipeline.org/rDataPipeline/reference/patch_data.html +https://www.fairdatapipeline.org/rDataPipeline/reference/post_data.html +https://www.fairdatapipeline.org/rDataPipeline/reference/rDataPipeline-package.html +https://www.fairdatapipeline.org/rDataPipeline/reference/raise_issue.html +https://www.fairdatapipeline.org/rDataPipeline/reference/raise_issue_config.html +https://www.fairdatapipeline.org/rDataPipeline/reference/raise_issue_repo.html +https://www.fairdatapipeline.org/rDataPipeline/reference/raise_issue_script.html +https://www.fairdatapipeline.org/rDataPipeline/reference/random_hash.html +https://www.fairdatapipeline.org/rDataPipeline/reference/read_array.html +https://www.fairdatapipeline.org/rDataPipeline/reference/read_distribution.html +https://www.fairdatapipeline.org/rDataPipeline/reference/read_estimate.html +https://www.fairdatapipeline.org/rDataPipeline/reference/read_table.html +https://www.fairdatapipeline.org/rDataPipeline/reference/register_issue_dataproduct.html +https://www.fairdatapipeline.org/rDataPipeline/reference/register_issue_script.html +https://www.fairdatapipeline.org/rDataPipeline/reference/remove_empty_parents.html +https://www.fairdatapipeline.org/rDataPipeline/reference/resolve_read.html +https://www.fairdatapipeline.org/rDataPipeline/reference/resolve_version.html +https://www.fairdatapipeline.org/rDataPipeline/reference/resolve_write.html +https://www.fairdatapipeline.org/rDataPipeline/reference/validate_fields.html +https://www.fairdatapipeline.org/rDataPipeline/reference/write_array.html +https://www.fairdatapipeline.org/rDataPipeline/reference/write_distribution.html +https://www.fairdatapipeline.org/rDataPipeline/reference/write_estimate.html +https://www.fairdatapipeline.org/rDataPipeline/reference/write_table.html +https://www.fairdatapipeline.org/rDataPipeline/software-checklist.html + diff --git a/software-checklist.html b/software-checklist.html index b4ee3cef..d53a0405 100644 --- a/software-checklist.html +++ b/software-checklist.html @@ -1,9 +1,9 @@ -SCRC Software checklist • rDataPipelineSCRC Software checklist • rDataPipeline - +
- +
@@ -93,12 +93,9 @@

Overall statement
  • -Yes
    • -
  • -Yes, with caveats
    • -
  • -No
    • +
      • +
      • +

    The code is well written and includes adequate documentation. Unit testing has good coverage and is fully automated via continuous integration. The Data Pipeline is not yet being used in practice and so bugs may yet be revealed. Additionally, further work is required to implement cross validation against the other language implementations.

    @@ -113,14 +110,10 @@

  • -Sufficiently addressed
    • -
  • -Some work remaining or caveats
    • -
  • -Needs to be addressed
    • -
  • -N/A
    • +
      • +
      • +
      • +

    @@ -131,12 +124,9 @@

    Are there appropriat
  • Is there CI?
  • Is everything you need to run the tests (including documentation) in the repository (or the data pipeline where appropriate)?
    • -

    @@ -148,14 +138,10 @@

  • -Sufficiently addressed
    • -
  • -Some work remaining or caveats
    • -
  • -Needs to be addressed
    • -
  • -N/A
    • +
      • +
      • +
      • +

    @@ -163,12 +149,9 @@

    Has any sort of au
    • For C++, this might just be the compiler output when run with “all warnings”. It could also be more extensive static analysis. For other languages, it could be e.g. pylint, StaticLint.jl, etc.
    • If there are possible issues reported by such a tool, have they all been either fixed or understood to not be important?
    -
    • -Sufficiently addressed
      • -
    • -Some work remaining or caveats
      • -
    • -Needs to be addressed
      • +
        • +
        • +

      lintr has identified a number of cosmetic issues that were considered low priority.

    @@ -178,12 +161,9 @@

  • -Sufficiently addressed
    • -
  • -Some work remaining or caveats
    • -
  • -Needs to be addressed
    • +
      • +
      • +

    Though the code has survived multiple iterations of the project, it is well structured, commented and documented. Further refactoring is required to reduce duplication and improve modularity.

    @@ -195,12 +175,9 @@

    Is there sufficient documentation?Does the code have algorithm documentation? e.g. something that describes how the model is actually simulated, or inference is performed?
  • Is all the documentation up to date?
    • -

    @@ -211,24 +188,18 @@

    Is there suitable collab
  • Is an issue tracker used?
  • Are there contribution guidelines?
    • -
    • -Sufficiently addressed
      • -
    • -Some work remaining or caveats
      • -
    • -Needs to be addressed
      • +
        • +
        • +

      The code is stored in a GitHub repository, which includes a licence and issue tracking.

    Are software dependencies listed and of appropriate quality?

    -
    • -Sufficiently addressed
      • -
    • -Some work remaining or caveats
      • -
    • -Needs to be addressed
      • +
        • +
        • +

      Dependencies are listed in the DESCRIPTION file.

    @@ -237,14 +208,10 @@

    Is input and out
    • Does the code use the data pipeline for all inputs and outputs?
    • Is the code appropriately parameterized (i.e. have hard coded parameters been removed)?
    -
    • -Sufficiently addressed
      • -
    • -Some work remaining or caveats
      • -
    • -Needs to be addressed
      • -
    • -N/A
      • +
        • +
        • +
        • +

    @@ -265,15 +232,15 @@

    Is input and out

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + +