Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Dataset

Dataset class.

Hierarchy

  • ItemGroup
    • Dataset

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Dataset(__namedParameters?: DatasetParameters): Dataset

  • Parameters

    • __namedParameters: DatasetParameters = {}

    Returns Dataset

Properties

Optional analysisVariables

analysisVariables: {}

CDISC Library attribute.

Type declaration

coreObject

coreObject: CoreObject

CLA Wrapper attribute. Object used to send API requests and store technical information. Must be the same object for all classes within an instance of a CdiscLibrary class.

Optional dataStructure

dataStructure: object

CDISC Library attribute.

Optional datasetVariables

datasetVariables: {}

CDISC Library attribute.

Type declaration

Optional description

description: object

CDISC Library attribute.

Optional fields

fields: {}

CDISC Library attribute.

Type declaration

Optional href

href: string

CDISC Library API endpoint.

Optional id

id: string

CLA Wrapper attribute. Item group class ID.

Optional itemType

itemType: "fields" | "analysisVariables" | "datasetVariables"

CLA Wrapper attribute. Name of the item type (field, analysisVariable, datasetVariable). Corresponds to an object name of the classes which are extending ItemGroup class (Dataset, Domain, VariableSet).

Optional label

label: string

CDISC Library attribute.

Optional name

name: string

CDISC Library attribute.

Optional scenarios

scenarios: {}

CDISC Library attribute.

Type declaration

Optional type

type: string

CDISC Library attribute. Value of the _links.self.type.

Methods

findMatchingItems

  • findMatchingItems(name: string, options: MatchingOptions): ItemType[]

  • Find all matching variables/fields. For example TRxxPGy matches TR01PG12.

    Parameters

    • name: string

      Variable/Field name.

    • options: MatchingOptions

    Returns ItemType[]

    Array of matched items.

getFormattedItems

  • getFormattedItems(format: "json" | "csv", addItemGroupId?: boolean, additionalProps?: object): string | object[]

  • Get items in a specific format.

    Parameters

    • format: "json" | "csv"

      Specifies the output format. Possible values: json, csv.

    • addItemGroupId: boolean = false
    • Optional additionalProps: object

    Returns string | object[]

    String with formatted items or an array with item details.

getItem

  • Get an object with specified item name

    property

    {String} name Variable/field name.

    Parameters

    • name: string

    Returns ItemType

    An object with variable/field if found

getItems

  • getItems(): Items

  • Get an object with all variables/fields for that item set. Note that for CDASHIG Scenarios have overlapping fields. Only one field is returned by this method.

    Returns Items

    An object with variables/fields.

getNameList

  • getNameList(): string[]

  • Get an array with the list of names for all items.

    Returns string[]

    An array with item names.

getRawResponse

  • getRawResponse(href?: string): Promise<object>

  • Get raw API response

    Parameters

    • Optional href: string

      CDISC Library API endpoint. If not specified, href attribute of the object is used.

    Returns Promise<object>

    Returns a JSON response if the request was successfull, otherwise returns undefined.

load

  • load(href?: string): Promise<boolean>

  • Load object from the CDISC Library

    Parameters

    • Optional href: string

      CDISC Library API endpoint. If not specified, href attribute of the object is used.

    Returns Promise<boolean>

    Returns true in the object was successfully loaded, false otherwise

parseItemGroupResponse

  • parseItemGroupResponse(itemRaw: any): void

  • Parse API response to variable set.

    Parameters

    • itemRaw: any

      CDISC API response.

    Returns void

parseResponse

  • parseResponse(raw: any): void

  • Parse API response to dataset

    Parameters

    • raw: any

      Raw CDISC API response

    Returns void

toSimpleObject

  • toSimpleObject(): any

  • Convert class to a simple object, removes methods and technical elements (e.g., coreObject).

    Returns any

    A new object

Generated using TypeDoc