get_user_metadata: Load user-supplied metadata

Description Usage Arguments Value

View source: R/get_user_metadata.R

Description

This internal function loads user-supplied metadata from a JSON file.

Usage

1
get_user_metadata(user_json_file)

Arguments

user_json_file

A JSON file describing mappings between internal names and names in the actual data files. It can contain the following entries:

content

The name of the column describing sample content.

concentration

The name of the column containing the concentration series.

fret_channel

The name of the column containing fluorescence intensities from the FRET channel.

acceptor_channel

The name of the column containing fluorescence intensities from the acceptor channel.

donor_channel

The name of the column containing fluorescence intensities from the donor channel.

titration

The name describing points of the titration series.

acceptor_only

The name describing points of the control series with only acceptor.

donor_only

The name describing points of the control series with only donor.

buffer_only

The name describing points of the control series with only buffer.

parallel

The name of the column containing fluorescence intensities from the parallel polarization plane.

perpendicular

The name of the column containing fluorescence intensities from the perpendicular polarization plane.

polarization

The name of the column containing fluorescence polarization.

anisotropy

The name of the column containing fluorescence anisotropy.

intensity

The name of the column containing fluorescence intensity.

baseline

The name describing points of the baseline series in a fluorescence polarization or anisotropy dataset.

Value

An invisible copy of the original environment containing default metadata. As a side effect, updates the column and sample names in the package-wide environment.


Guilz/rfret documentation built on Oct. 18, 2021, 2:14 p.m.