PatentsLandscapes

Documentation for PatentsLandscapes.

PatentsLandscapes.TaxonomicFilterType

Struct representing a database filter using a custom taxonomy.

  • taxonomy: The name of the taxonomy by which to filter.
  • included_taxa: The names of the individual taxa to include. If an empty list is passed, all known taxa within the taxonomy are included.
source
PatentsLandscapes.define_taxon!Method

Define a custom taxonomic group of applications/families, with membership based on an AbstractFilter.

Required arguments:

  • ds: The data source on which to operate. Membership information for the new taxon is stored in this data source.
  • taxonomy_name: The name of the taxonomic system, e.g. "base_material".
  • taxon_name: The name of the taxon or group within the system, e.g. "steel", "wood", etc.
  • filter: An AbstractFilter that determines which applications or families are included in the taxon.

Keyword arguments:

  • expand = true: Toggles whether existing membership entries for the taxon are left in place. Otherwise, the taxon is fully redefined based on the filter specified, without respecting existing memberships.
source
PatentsLandscapes.prepdataFunction
prepdata(
    ds::AbstractDataSource,
    type::Analysis,
    level::AnalysisLevel,
    [filter::AbstractFilter],
    [g1::Grouping],
    [g2::Grouping],
    [g3::Grouping]
)::DataFrame

Perform data retrieval and calculation for an analysis, yielding the results as a DataFrame.

Parameters (in order):

  • ds: The AbstractDataSource containing the data for the analysis.
  • type: The type of Analysis to be conducted.
  • level: The DataLevel for the analysis, e.g. ApplicationLevel(), FamilyLevel() etc.
  • filter (optional): A filter defining the subset of data to be included in the analysis. If not specified, all data stored in ds is included.
  • g1 - g3 (optional): Up to three Grouping categories to use in the analysis.
source