Package: viafoundry 1.0.1

Alper Kucukural

viafoundry: R Client for 'Via Foundry' API

'Via Foundry' API provides streamlined tools for interacting with and extracting data from structured responses, particularly for use cases involving hierarchical data from Foundry's API. It includes functions to fetch and parse process-level and file-level metadata, allowing users to efficiently query and manipulate nested data structures. Key features include the ability to list all unique process names, retrieve file metadata for specific or all processes, and dynamically load or download files based on their type. With built-in support for handling various file formats (e.g., tabular and non-tabular files) and seamless integration with API through authentication, this package is designed to enhance workflows involving large-scale data management and analysis. Robust error handling and flexible configuration ensure reliable performance across diverse data environments. Please consult the documentation for the API endpoint for your installation.

Authors:Alper Kucukural [aut, cre], Via Scientific [aut, cph]

viafoundry_1.0.1.tar.gz
viafoundry_1.0.1.zip(r-4.7-any)viafoundry_1.0.1.zip(r-4.6-any)viafoundry_1.0.1.zip(r-4.5-any)
viafoundry_1.0.1.tgz(r-4.6-any)viafoundry_1.0.1.tgz(r-4.5-any)
viafoundry_1.0.1.tar.gz(r-4.7-any)viafoundry_1.0.1.tar.gz(r-4.6-any)
viafoundry_1.0.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
viafoundry/json (API)

# Install 'viafoundry' in R:
install.packages('viafoundry', repos = c('https://viascientific.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/viascientific/viafoundry-r-sdk/issues

On CRAN:

Conda:

2.70 score 342 downloads 61 exports 24 dependencies

Last updated from:55a7332f28. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develOK135
source / vignettesOK249
linux-releaseOK131
macos-releaseOK153
macos-oldrelOK163
windows-develOK67
windows-releaseOK92
windows-oldrelOK67
wasm-releaseOK132

Exports:addFilesToDatasetauthenticateauthenticate_tokencall_endpointcheckProcessUsagecreateCanvascreateCollectioncreateFieldcreateMenuGroupcreateParametercreateProcesscreateProcessConfigdeleteCanvasdeleteCollectiondeleteDatadeleteFielddeleteParameterdeleteProcessdiscoverduplicateProcessfetchReportDatafilterParametersget_api_statusget_bearer_tokengetAllFileNamesgetAllReportPathsgetCanvasgetCanvasFieldsgetCollectiongetCollectionFieldsgetDatagetFieldgetFieldsForCollectiongetFileNamesgetMenuGroupByNamegetPipelineParametersgetProcessgetProcessNamesgetProcessRevisionsgetReportDirslistMenuGroupslistParameterslistProcessesload_configloadFileloginprepareSessionHistorysearchCanvassearchCollectionssearchDatasearchDatasetFilessearchFieldsupdateCanvasupdateCollectionupdateDataupdateFieldupdateMenuGroupupdateParameterupdateProcessuploadReportFileuploadSessionHistory

Dependencies:askpassclicurldplyrgenericsgluehttrjsonlitelifecyclemagrittrmimeopensslpillarpkgconfigR6rlangstringistringrsystibbletidyselectutf8vctrswithr

Readme and manuals

Help Manual

Help pageTopics
Add Files to DatasetaddFilesToDataset
Authenticate with the `Via Foundry` APIauthenticate
Authenticate with Tokenauthenticate_token
Calculate expiration date (30 days from now)calculate_expiration_date
Call an API Endpoint with Optional File Uploadcall_endpoint
Check Process UsagecheckProcessUsage
Create CanvascreateCanvas
Create CollectioncreateCollection
Create FieldcreateField
Create Menu GroupcreateMenuGroup
Create a ParametercreateParameter
Create a New ProcesscreateProcess
Create Process ConfigcreateProcessConfig
Delete canvasdeleteCanvas
Delete CollectiondeleteCollection
Delete Data EntrydeleteData
Delete FielddeleteField
Delete a ParameterdeleteParameter
Delete a ProcessdeleteProcess
Discover Available Endpointsdiscover
Duplicate ProcessduplicateProcess
Fetch the `JSON` data for a reportfetchReportData
Filter ParametersfilterParameters
Get API Statusget_api_status
Get bearer token using the cookie tokenget_bearer_token
Get headers for API requestsget_headers
Recursively extract all files from deeply nested report JSONgetAllFileNames
Get unique report directories and attempt IDs for a specific reportgetAllReportPaths
Get canvasgetCanvas
Get canvas FieldsgetCanvasFields
Get CollectiongetCollection
Get Collection FieldsgetCollectionFields
Get Data EntrygetData
Get FieldgetField
Get Fields for a Specific Collection in a canvasgetFieldsForCollection
Get file names for a specific processgetFileNames
Get Menu Group by NamegetMenuGroupByName
Get Pipeline ParametersgetPipelineParameters
Get Process InformationgetProcess
Get unique process namesgetProcessNames
Get Process RevisionsgetProcessRevisions
Get directories following pub web in the route pathgetReportDirs
List Menu GroupslistMenuGroups
List All ParameterslistParameters
List All ProcesseslistProcesses
Load Configurationload_config
Load or download a file from a process and file nameloadFile
Login and retrieve the cookie tokenlogin
Prepare Session HistoryprepareSessionHistory
Search canvassearchCanvas
Search CollectionssearchCollections
Search Collection DatasearchData
Search Dataset FilessearchDatasetFiles
Search FieldssearchFields
Update canvasupdateCanvas
Update CollectionupdateCollection
Update Data EntryupdateData
Update FieldupdateField
Update Menu GroupupdateMenuGroup
Update a ParameterupdateParameter
Update a ProcessupdateProcess
Upload a file to a specific reportuploadReportFile
Upload Session HistoryuploadSessionHistory