Package index • improveR

Step and workflow management

attachStep(): attaches a step to its parent

changeStepDescription(): changes the step description

changeStepRationale(): changes the step rationale

createStepEnv(): Create a new step environment

createStepTemplateEnv(): Create a new step template environment

createWorkflow(): Create a new workflow object

createWorkflowTemplateEnv(): Create a workflow template environment from an existing workflow

detachStep(): detaches a step from its parent

finishRunResource(): finishRunResource

getStep(): getStep reads a step and its processes and generates a new handle

getStepTemplate(): getStepTemplate reads a step and its processes and generates a new handle

getToolInstances(): getToolInstances returns an environement with all tool instances. in order to relaod tools from the server use resetToolInstances

resetToolInstances(): resetToolInstances clears the cache for toolInstances and reloads everything from the server

runStepResource(): runStepResource

createAnalysisTree(): creates a workflow/analysis tree in the repository and returns the resource object

workflowTemplateFromJSON(): Load workflow template from JSON file

Authentication

clearConnectionData(): clearConnectionData

improveClose(): improveClose

improveConnect(): improveConnect

improveConnected(): improveConnected

improveDisconnect(): improveDisconnect

improveEditable(): improveEditable

improveOAuth(): improveOAuth

refreshToken(): Refresh token using registered refresher

setEditable(): setEditable

Review

createReview(): creates a new review

createReviewComment(): creates a comment for a review

createReviewEntry(): creates review entries for a review

createReviewEntryComment(): creates a comment for a review entry

createReviewer(): adds a user as reviewer to a review

getReviewComments(): getReviewComments

getReviewEntries(): getReviewEntries

getReviewEntryComments(): getReviewEtnryComments

getReviewers(): getReviewers

loadReviewComments(): loads all the review comments for a review it uses caching the result is returned as a data frame

loadReviewEntries(): loads all the review entries for a review it uses caching the result is returned as a data frame

loadReviewEntryComments(): loads all the comments for a review entry it uses caching the result is returned as a data frame

loadReviewers(): loads all the reviewers for a review it uses caching the result is returned as a data frame

loadReviews(): loads all registered reviews it uses caching the result is returned as a data frame

loadRunserver(): loads runserver by label

Meta Data and Resource Relations

addBulkMetaDate(): adds metadata value to a resource, always adds, never updates

addMetaDate(): adds metadata value to a resource, always adds, never updates

createResourceRelation(): creates a new resource relation

deleteMetaDate(): deletes metadata from a resource

deleteResourceRelation(): deletes a resource relation

CLI tools

cloneCli(): Clone CLI Resource

createContentCache(): Create Content Cache

pullCli(): Pull CLI

pushCli(): Push CLI

pushRunCli(): Push Run CLI

versionCli(): Version CLI

Basic modify operations

copy(): copies resources multiple sources can be copied at once if multiple sources are copied target needs to be a container and targetName empty if only one source is copied, a new name can be specified, this can be done via a path or via targetName

delete(): deletes resources multiple sources can be deleted at once

deleteReviewEntry(): deletes all review entries from a review

deleteReviewer(): removes a reviewer from a review

move(): moves resources multiple sources can be moved at once if multiple sources are moved target needs to be a container and targetName empty if only one source is moved, a new name can be specified, this can be done via a path or via targetName

createFile(): creates a file in the repository and returns the resource object

createFolder(): creates a folder in the repository and returns the resource object

createLink(): createLink creates a link to a resource, currently always the latest version of the resource is used

createExternalLink(): creates an external link in the repository and returns the resource object

Miscellaneous

byNotEmpty(): byNotEmpty by that automatically uses the complete dataframe and returns null if an empty or non existing data frame is handed over

byNotEmptyAsDf(): byNotEmptyAsDf by that automatically uses the complete dataframe and returns null if an empty or non existing data frame is handed over it automatically tries to convert the result list to a data frame again

convertImproveTimestampToPosix(): convertImproveTimestampToPosix

createWorkflowTemplateForImport(): Create a workflow template environment specifically for import operations

exportWorkflow(): Export a Workflow to a Portable Zip File

getData(): gets a data table and retrieves the caption and description by the resource ID or entity ID .xls and .xlsx files assumed to be excel, .rds as RDS, .sas7bdat as SAS all others as CSV

getGraphics(): gets a graphics object

getHTML(): gets a HTML object

getR(): gets a R object

getTextString(): gets a text file as chracter string and retrieves the caption and description by the resource ID or entity ID

importWorkflow(): Import a Workflow from a Zip File into a Repository Folder

includeGraphics(): Includes a picture in rMarkdown, with knitr::includeGraphics, used within a code block, only for a single image

loadHistory(): loads the history by the resourceId, entity ID or entity version ID it uses caching the results are returned as a data frame or a list of data frames the dates are also converted to posix dates via convertImproveTimestampToPosix resourceId can be a list

loadMetaData(): loads the history by the resourceId, entity ID or entity version ID it uses caching the results are returned as a data frame or a list of data frames the dates are also converted to posix dates via convertImproveTimestampToPosix resourceId can be a list

loadMetaDataDefinition(): loads one meta data definitions by name for a scope, the default scope is "Improve Client"

loadMetaDataDefinitionPickList(): loads one meta data definition picklist values by name for a scope, the default scope is "Improve Client"

loadMetaDataDefinitions(): loads all meta data definitions for a scope, the default scope is "Improve Client"

loadParentStep(): loads the parent step of one step, not applicable to multiple steps

loadResource(): loadResource

lockResource(): lockResource

query(): performs this query against the elastic search

queryFolder(): performs this query against the elastic search within one folder

resetCache(): resetCache

showGraphics(): Includes a picture in rMarkdown, creates a string that has to be outputted

showHTML(): Includes HTML in rMarkdown, creates a string that has to be outputted

sourceR(): sources R objects

unloadHistory(): unloadHistory

unloadMetaData(): unloadMetaData

unloadMetaDataDefinitions(): unloadMetaDataDefinitions

unloadParentStep(): unloadParentStep

unlockResource(): unlockResource

updateFileContent(): updates file content, prerequisite, must be a file multiple files can be updated at once

updateHistory(): updateHistory

updateMetaData(): updateMetaData

updateMetaDataDefinitions(): updateMetaDataDefinitions

updateParentStep(): updateParentStep reloads the runservers from the repository

uploadFolder(): uploads a complete folder prerequisite, must be a folder

whoami(): retrieves the name of the user that started the step or was used to authenticate

Other

reexports %>%: Objects exported from other packages

applyTokenData(): Apply token data to session

checkConnect(): checkConnect

effectiveRights(): returns effective rights for a user on a specific resource

getActiveTokenRefresher(): Get active token refresher

getCopy(): gets a file objectas local copy

getCurrentTokenData(): Get current token data

getFile(): gets a file object

getFilesFromFolder(): retrieves a list of files from within a folder

getFullFolderAuditTrail(): retrieves recursive audit trail for a specific folder

getImproveInternalDir(): Get improve internal directory

getImproveWorkspaceDir(): Get improve workspace directory

getLogFile(): getLogFile

getMainProcess(): getMainProcess

getMetaData(): gets a metadata data frame

getMetaDataMap(): loads the metadata of a given resource and writes it as string values into a list

getParent(): returns the parent of anything resolved by getCorrectId

getProcessFileVariables(): getProcessFileVariables

getRepositoryVersion(): getRepositoryVersion

getWorkflow(): getWorkflow reads a tree and creates stepEnvs for all steps

improveInit(): initialises modules, also automatically connects

isFileUp2Date(): isFileUp2Date

isResourceUp2Date(): isResourceUp2Date

listTokenRefreshers(): List registered token refreshers

loadAuditTrail(): loads the auditTrail by the resourceId, entity ID or entity version ID it uses caching the results are returned as a data frame or a list of data frames the dates are also converted to posix dates via convertImproveTimestampToPosix resourceId can be a list

loadChildResources(): loadChildResources

loadChildSteps(): loads all child steps by the resourceId, entity ID or entity version ID it uses caching the results are returned as a data frame the dates are also converted to posix dates via convertImproveTimestampToPosix resourceId can be a list

loadFile(): loadFile

loadFullChildResources(): loads all child resources by the resourceId, entity ID or entity version ID the childResources REST call does not return all the fields, like run status for steps, just the fields all resources have in common, with this function, the full resources are loaded it uses caching the results are returned as a data frame or a list of data frames the dates are also converted to posix dates via convertImproveTimestampToPosix resourceId can be a list

loadReferences(): loads the references by the resourceId, entity ID or entity version ID it uses caching the results are returned as a data frame or a list of data frames the dates are also converted to posix dates via convertImproveTimestampToPosix resourceId can be a list

loadRelationTypes(): loads all registered relation types

loadResourceFromServer(): loadResourceFromServer

loadResourceRelations(): loads all registered resource relations it uses caching the results are returned as a data frame or a list of data frames the dates are also converted to posix dates via convertImproveTimestampToPosix ident can be a list

loadResourceVersionFromServer(): loadResourceVersionFromServer

log_debug(): log_debug

log_error(): log_error

log_info(): log_info

log_warn(): log_warn

pwd(): pwd

registerTokenRefresher(): Register a token refresher plugin

shouldRefreshToken(): Check if token should be refreshed

strip(): strip

unauthenticatedREST(): unauthenticatedREST

unloadAuditTrail(): unloadAuditTrail

unloadChildResources(): unloadChildResources

unloadChildSteps(): unloadChildSteps

unloadFile(): unloadFile

unloadFullChildResources(): unloadFullChildResources

unloadReferences(): unloadReferences

unloadRelationTypes(): unloads all relation types

unloadResource(): unloadResource

unloadResourceRelations(): unloads all resource relations

unloadReviewComments(): unloads the review comments for a review

unloadReviewEntries(): unloads the review entries for a review

unloadReviewEntryComments(): unloads the comments for a review entry

unloadReviewers(): unloads the reviewers for a review

unloadReviews(): unloads all reviews

updateAccessToken(): Update access token in current session

updateAuditTrail(): updateAuditTrail

updateChildResources(): updateChildResources

updateChildSteps(): updateChildSteps

updateFile(): updateFile

updateFullChildResources(): updateFullChildResources

updateLinks(): Update link resource(s)

updateMetaData(): updateMetaData

updateMetaDate(): updates metadata value to a resource

updateMetaDateById(): updates metadata value to a resource

updateParentStep(): updateParentStep reloads the runservers from the repository

updateReferences(): updateReferences

updateRelationTypes(): reloads the relation types

updateResource(): updateResource

updateResourceRelation(): updates a resource relation

updateResourceRelations(): reloads the resource relations

updateReviewComments(): reloads the review comments for a review

updateReviewEntries(): reloads the review entries for a review

updateReviewEntryComments(): reloads the comments for a review entry

updateReviewers(): reloads the reviewers for a review

updateReviews(): reloads the reviews

users(): returns a data frame of all users

getTokenRefresher(): Get registered token refresher