Package 'pzfx'

Title: Read and Write 'GraphPad Prism' Files
Description: Read and write 'GraphPad Prism' '.pzfx' files in R.
Authors: Yue Jiang [aut, cre]
Maintainer: Yue Jiang <[email protected]>
License: MIT + file LICENSE
Version: 0.3.0
Built: 2024-11-11 06:31:02 UTC
Source: https://github.com/yue-jiang/pzfx

Help Index


List all tables in a 'GraphPad Prism' '.pzfx' file.

Description

List all tables in a 'GraphPad Prism' '.pzfx' file.

Usage

pzfx_tables(path)

Arguments

path

Path to the '.pzfx' file

Value

a character string vector

Examples

pzfx_file <- system.file("extdata/exponential_decay.pzfx", package = "pzfx", mustWork = TRUE)
pzfx_tables(pzfx_file)

Read one table from a 'GraphPad Prism' '.pzfx' file

Description

Read one table from a 'GraphPad Prism' '.pzfx' file

Usage

read_pzfx(path, table = 1, strike_action = "exclude", date_x = "character")

Arguments

path

Path to the '.pzfx' file.

table

Table to read. Either a string (the name of a table), or an integer (the position of the table). If neither argument specifies the table, defaults to the first table.

strike_action

One of c("exclude", "keep", "star") or c("e", "k", "s"). Should stricken values in the original .pzfx be excluded, kept or labeled with a trailing "*". If a trailing "*" is added, the column will be of type character.

date_x

One of c("numeric", "character", "both") or c("n", "c", "b"). Should x column of format "Date" be handled as numeric (time elapsed from the first time point), character (the date string encoded by Prism, for example "8-Sep-2008"), or both (leading to two columns).

Value

a data frame

Examples

pzfx_file <- system.file("extdata/exponential_decay.pzfx", package = "pzfx", mustWork = TRUE)
read_pzfx(pzfx_file, table = 1, strike_action="exclude", date_x="character")

Write one table or multiple tables to a 'GraphPad Prism' '.pzfx' file

Description

Write one table or multiple tables to a 'GraphPad Prism' '.pzfx' file. A table can be a 'matrix', a 'data.frame', or a 'tibble'. All elements of the table should be numeric.

Usage

write_pzfx(x, path, row_names = TRUE, x_col = NA, n_digits = NA)

Arguments

x

Input table or named list of tables that will be 'Data Tables' in the '.pzfx' file

path

Path to the output '.pzfx' file.

row_names

Logical. If row names of the input table should be preserved and become row titles in the output '.pzfx' file. If the length is greater than 1, it must match the length of list of input tables. Default: TRUE.

x_col

1-based column index or name of the column to be used as the 'X' column. If the length is greater than 1, it must match the length of list of input tables. All other columns in the input tables will be treated as "Y" columns in the output '.pzfx' file. Default: NA

n_digits

An integer specifying the number of digits to display for float values in the generated '.pzfx' file. This argument has no effect if data is of type 'integer'. Note this argument only affects how many digits are displayed. The actual data does not change.

Value

write_pzfx returns the input x invisibly.

Examples

pzfx_file <- system.file("extdata/exponential_decay.pzfx", package = "pzfx", mustWork = TRUE)
df <- read_pzfx(pzfx_file, table = 1, strike_action = "exclude")
write_pzfx(df, path = tempfile(fileext = ".pzfx"), row_names = TRUE)