Skip to content
This repository was archived by the owner on Aug 15, 2023. It is now read-only.

Update README.md#10

Open
kevinyang372 wants to merge 2 commits intomasterfrom
kevinyang372-patch-1
Open

Update README.md#10
kevinyang372 wants to merge 2 commits intomasterfrom
kevinyang372-patch-1

Conversation

@kevinyang372
Copy link
Copy Markdown
Contributor

No description provided.

@kevinyang372 kevinyang372 requested a review from MalteLL November 28, 2019 19:32
README.md Outdated
Comment on lines 42 to 45
```
activityPerformance(logName)
```
#### Example
```
activityPerformance("Incident_withImpactAttributes.csv")
activityPerformance(lanaURL, lanaToken, logId)
```

| .id | frequency | totalDuration | minDuration | maxDuration | avgDuration | standardDeviation| median |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

activityPerfomance is not really used anymore, I would just delete it from the readme

Comment on lines +30 to +36
#### Example Usage
```R
# With empty trace filter sequence
discoveredModel(lanaURL, lanaToken, logId)

# With non-empty trace filter sequence
discoveredModel(lanaURL, lanaToken, logId, traceFilterSequence = "trace sequence")
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add more documentation here about the different things that you receive through this call as well as listing all the default values and what they actually change. If you have questions about it, just let me know.

Comment on lines +61 to +71
Optional Parameters:
* `zDimension` (default = 'null')
* `aggrLevel` (default = 'traces')
* `followers` (default = 'null')
* `type` (default = 'aggregation')
* `cache` (default = 'null')
* `maxValueAmount` (default = 5)
* `activityExclusionFilter` (default = '[]')
* `traceFilterSequence` (default = '[]')
* `limit` (default = 10)
* `page` (default = 1)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please explain what these default values actually do.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants