Man pages for USGS-VIZLAB/vizlab
Utilities for building online data visualizations
| analytics | Generic function that will apply a particular analytics... |
| as.analytics | Coerce vizlab object to include analytics |
| as.fetcher | Coerce vizlab object to a fetcher type |
| as.parameter | Coerce vizlab object to a parameter type |
| as.publisher | coerce to a publisher |
| as.reader | Treat viz object as a reader Doesn't need to be generic at... |
| as.resource | coerce to resource |
| as.template | Coerce to template type publisher |
| as.visualizer | Coerce to a visualizer |
| authRemote | Log on to a remote file service |
| buildContext | Build context for templating |
| checkAndInstallNodeModule | Check if a node package is installed already or not. If not,... |
| checkInstalled | Check that a system library is installed |
| checkRelVizUrl | function to keep the absolute viz path or make the path... |
| checkRequired | Check required fields |
| checkThumbCompliance | helper to check thumbnail compliance |
| checkVizPackages | Report on the installation status of packages needed by the... |
| collectItemArguments | Read all arguments declared for all items into an R list |
| convb | Took code from here:... |
| createBlockMakefile | Create a single makefile from the information in viz.yaml |
| createCleanRule | Create the rules to clean out the make-relevant parts of the... |
| createConfigCall | Create the rules for the content make file |
| createMakeBatchRule | Create text for a make rule using RBATCH |
| createMakeBlockRules | Create the make rules for a block of the viz.yaml |
| createMakeDirs | Create directories mentioned in the makefile |
| createMakeEmptyRule | Create text for a make rule that has no commands |
| createMakefiles | Create fetch.make, etc. from the information in viz.yaml |
| createMakeItem | Make a collection of makefile rules appropriate to a... |
| createMakeMacros | Create the macros section |
| createMakeRulePair | Make the common rule pair relating IDs to files to commands |
| createMakeRunmakeRules | Create the rules to run/make/update the non-top makefiles |
| createMakeShellRule | Create text for a make rule that calls a shell command |
| createNewIssues | Create new issues on a repository from a JSON file. |
| createNewLabels | Create new labels on a repository from a JSON file. |
| createNewRepo | Create a new repository for a specified organization. |
| createProfile | Define user profile information |
| createProfile.Linux | Create user profile yaml file for Linux operating systems |
| createProfile.Mac | Create user profile yaml file for Mac operating systems |
| createProfile.Windows | Create user profile yaml file for Windows operating systems |
| createShortcuts | Create the top shortcuts |
| createTopMakefile | Create the top-level makefile, which runs/makes/updates the... |
| doExport | Return logical declaring whether file export (copying to... |
| exceededTimeToLive | Return logical: has the time to live been exceeded for this... |
| expandDependencies | Private function to publish a dependency. Returns either the... |
| export | Export content to target |
| exportLocation | Set where exports should be placed |
| fetch | Ensure data is on the local file system |
| fetchTimestamp | Update timestamp file if needed |
| fetchTimestamp.character | Routes the timestamp fetching to a more specific fetcher. |
| fetchTimestampHelpers | Methods to assist in writing and debugging custom... |
| fetchTimestampMethods | Functions to use as custom fetchTimestamp methods. |
| findProfileYaml | Find where the profile.yaml file is saved. |
| gatherDependencyList | Pull together vizlab object dependencies |
| getBlocks | Read vizlab config document and return specific blocks |
| getContentInfo | Get information on a content item from the viz.yaml |
| getContentInfos | Get information on one or more content items from the... |
| getLog | Display, optionally open, and return the contents of a log... |
| getLogPath | Get the path to the .Rout file corresponding to a viz id (or... |
| getPartialLibrary | Assemble whisker partials from vizlab package |
| getPreferences | Read the preferences.yaml file, if available, in the current... |
| getProfileInfo | Get information on profile settings |
| getRepoNames | Get a vector a repository names for a specific organization |
| getResourceFromLibrary | Internal function to get shared resources Implemented as a... |
| getVizInfo | Load yamls and find if the published date has passed yet |
| getVizlabVersion | Read the version of the vizlab config document |
| getVizYamlUrl | Get the full file path for the raw viz.yaml within a... |
| handleMarkdown | Replace any markdown text with rendered html |
| initializeVizRepo | Initialize the GitHub repo for a new viz. |
| lookupMimetype | Use mimetype lookup to get reader |
| needsTimestampOld | Determine whether an item should fetch a timestamp or not |
| parameter | Get parameter variables for project |
| prepSources | Combines and filters one or more script files into a single... |
| process | Process raw or intermediate data products into intermediate... |
| publish | Peform the publish step to ready the viz for hosting |
| publishLandingPage | Get information about other visualizations from VIZLAB to... |
| readData | Ensure data is on the local file system |
| readDepends | read multiple dependency datasets into environment |
| relativePath | Get webapp path |
| remove_publish_target | Helper to unpublish. similar to... |
| render | Render contents to file |
| replaceOrAppend | Append second list to first with overwrites |
| setupFoldersForFile | Sets up folders so file can be written without warnings |
| sourceScripts | Source R scripts |
| template | Reads a template file and returns the contents |
| uniqueness | Grab a random number to break the cache |
| unpublish | Delete the remake data but not the file from a publish target |
| updateConfigInfoFile | updateConfigInfoFile |
| updateThumbnails | Get thumbnail info for sematics |
| updateVizPackages | [Re]install any missing or outdated packages |
| validateVizYaml | Find obvious errors in your viz.yaml |
| visualize | Visualize raw or intermediate data products into intermediate... |
| vizlab | Utilities for building online data visualizations |
| vizmake | Build a visualization project |
| vizPackageStatus | Identify any missing or outdated packages |
| vizSkeleton | vizlab vizSkelton |
| viz.yaml | How to write a viz.yaml |
| webpacker | Run webpack for the project |
