edpclient (version 0.5.1)

visibility: Visibility

Description

Get or set visibility of populations

Usage

visibility(x)
  add_reader(x, reader = NULL, reader_domain = NULL)

Arguments

x

a population (from population) or a population model (from popmod)

reader

email address of a person to give read access to

reader_domain

email domain of an organization to give read access to

Value

Both visibility and add_reader return an object with keys owner (a length-one character vector), public (a length-one logical vector), readers (a character vector of email addresses), and reader_domains (a character vector of email domains).

Details

visibility and add_reader manipulate the permissions of a population. They can be applied to population models, but that is only a convenience; population models do not have ACLs independent of populations.

When calling add_reader, exactly one of reader and reader_domain must be specified.

Examples

# NOT RUN {
  
# }
# NOT RUN {
    pm <- popmod(sess, "p-0123456789abcdef")
    add_reader(pm, "[e-mail]")
    add_reader(pm, reader_domain = "example.com")
    print(visibility(pm))
  
# }