Protein Family Ref Data
Data Type: protein_family_ref
Primary Key: family_id
Attributes
-
_version_
(number)
-
date_inserted
(date)
- ISO-8601 UTC datetime when the protein-family reference row was created in BV-BRC; enables incremental ETL and provenance tracking. "2023-04-30T11:23:14Z"
-
date_modified
(date)
- Updated whenever family_product or family_type is revised; clients compare this to cached copies and refresh only changed rows. "2025-04-08T08:06:12Z"
-
family_id
*
(string)
- Primary key. Stable accession for the family. Two namespaces are common:• PGF_ IDs — “PATRIC Global Families” (cross-genus, 30 % AA ID clustering).• PLF_ IDs — “PATRIC Local Families” (within-genus, 50 % AA ID). Serves as the join key that links individual genome features to multiple comparative-genomics tools (alignments, heat-maps, phylogenies). "PGF_00001234"
-
family_product
(string)
- Curator-approved functional description summarising the consensus activity of the family’s members. Displayed in family browsers, alignment viewers, and annotation tables; helps users understand what a family “does”. "DNA repair protein RecA"
-
family_type
(string)
- Indicates the clustering scheme:• PGFam = cross-genus global family (broad, coarse-grained).• PLFam = local within-genus family (finer resolution).Additional values such as FIGfam may appear for legacy sets. Used by UI filters and pipeline decisions (e.g. choose PGFams for genus-wide core analysis, PLFams for strain-level comparison). "PGFam"
API
GET :family_id
Retrieve a protein_family_ref data object by family_id
EXAMPLE
https://www.bv-brc.org/api/protein_family_ref/PLF_32008_00319462
Try It!
QUERY :query
Query for protein_family_ref data objects with an RQL Query
Return Formats
Requests may include an HTTP ACCEPT header from this list to transform the data into the requested type.
-
application/json - Returns results as an array of JSON objects
-
application/solr+json - Results results in SOLR JSON response format
-
text/csv - Returns results in Comma Separated values (CSV) format. Columns are separated by ','. Multi-value columns are separated by ';'. Rows are separated by new line
-
text/tsv - Returns results in Tab Separated values (TSV) format. Columns are separated by a tab. Multi-value columns are separated by ';'. Rows are separated by new line
-
application/vnd.openxmlformats - Returns objects as an MS Excel document
EXAMPLE
- Query for protein_family_ref data objects with a family_id equal to PLF_32008_00319462. Return results as a JSON Array.
https://www.bv-brc.org/api/protein_family_ref/?eq(family_id,PLF_32008_00319462)
Try It!