R: Internal function to get, set or initialize system metadata

meta_system {quanteda} | R Documentation

## Internal function to get, set or initialize system metadata

### Description

Sets or initializes system metadata for new objects.

### Usage

    meta_system(x, field = NULL)

    meta_system(x, field = NULL) <- value

    ## S3 replacement method for class 'corpus'
    meta_system(x, field = NULL) <- value

    ## S3 replacement method for class 'tokens'
    meta_system(x, field = NULL) <- value

    ## S3 replacement method for class 'dfm'
    meta_system(x, field = NULL) <- value

    ## S3 replacement method for class 'dictionary'
    meta_system(x, field = NULL) <- value

    meta_system_defaults()

### Arguments

`x` | an object for which the metadata will be read or set
`field` | metadata field name(s); if `NULL` (default), return all metadata names
`value` | new value of the metadata field
`source` | character; the input object class

### Value

`meta_system` returns a list with the object's system metadata. It is literally a wrapper to `meta(x, field, type = "system")()`.

`meta_system<-` returns the object with the system metadata modified. This is an internal function and not designed for users!

`meta_system_defaults` returns a list of default system values, with the user setting the "source" value. This should be used to set initial system meta information.

### Examples

    corp <- corpus(c(d1 = "one two three", d2 = "two three four"))
    # quanteda:::`meta_system<-`(corp, value = quanteda:::meta_system_defaults("example"))
    quanteda:::meta_system(corp)

[Package quanteda version 3.1.0 Index]