Type Alias RoleBasedFiles

type RoleBasedFiles = {
    data: (FlowrDataListFile | FlowrSysdataFile | FlowrFileProvider)[];
    description: FlowrDescriptionFile[];
    documentation: (
        | FlowrRdFile
        | FlowrRdIndexFile
        | FlowrRdMacroFile
        | FlowrRdTopicIndexFile
        | FlowrRdMetaFile
    )[];
    environment: FlowrFileProvider[];
    install: FlowrFileProvider[];
    license: FlowrFileProvider[];
    manifest: FlowrManifestFile[];
    namespace: FlowrNamespaceFile[];
    news: FlowrNewsFile[];
    other: FlowrFileProvider[];
    source: FlowrFileProvider[];
    startup: FlowrFileProvider[];
    test: FlowrFileProvider[];
    vignette: FlowrFileProvider[];
    "virtual-env": FlowrFileProvider[];
}

Index

Properties

data description documentation environment install license manifest namespace news other source startup test vignette virtual-env

Properties

data

data: (FlowrDataListFile | FlowrSysdataFile | FlowrFileProvider)[]

a data/datalist (FlowrDataListFile), a package's system data (FlowrSysdataFile), or any other data file, which has no special support

description

description: FlowrDescriptionFile[]

documentation

documentation: (
    | FlowrRdFile
    | FlowrRdIndexFile
    | FlowrRdMacroFile
    | FlowrRdTopicIndexFile
    | FlowrRdMetaFile
)[]

what states which manual page documents a name: the man/ pages and macros, an INDEX, and an installed package's help/AnIndex or Meta/Rd.rds

environment

environment: FlowrFileProvider[]

install

install: FlowrFileProvider[]

license

license: FlowrFileProvider[]

manifest

manifest: FlowrManifestFile[]

namespace

namespace: FlowrNamespaceFile[]

news

news: FlowrNewsFile[]

other

other: FlowrFileProvider[]

source

source: FlowrFileProvider[]

startup

startup: FlowrFileProvider[]

test

test: FlowrFileProvider[]

vignette

vignette: FlowrFileProvider[]

virtual-env

"virtual-env": FlowrFileProvider[]