make_animals_df: Convert metadata to a data frame

Description Usage Arguments Value Examples

View source: R/make_animals_df.R

Description

Given a response object, converts the animal metadata into a data frame. The result should be relatively tidy if each animal has only one value for every field, but there will be duplicated columns if animals have multiple values for a given field. For example, if an animal is in multiple cohorts, there will be multiple cohortName columns

Does a little extra work beyond make_animals_df() to ensure that some expected columns are present.

Usage

1
2
3
make_animals_df(data, include_params = TRUE)

tidy_animals_by_job(data, include_params = TRUE)

Arguments

data

The output response object from get_animals() or get_animals_by_job()

include_params

Boolean indicating if query parameters should be added as columns to the resulting data frame. This is useful for appending the jobNumber to the resulting data frame.

Value

A data frame containing metadata on the animals

Examples

1
2
3
4
5
## Not run: 
r <- get_animals()
make_animals_df(r)

## End(Not run)

Sage-Bionetworks/climbr documentation built on April 25, 2020, 4:08 p.m.